Arduino Virtual Stepper library

Table of contents

• Overview
• At a glance
• Getting started
• Repository structure
• Contributions to the project
• Questions and answers
• Attributions and references

Overview

C++ library containing controllers for different stepper motors. The library does not use any motor driver for interacting with the stepper motors, thus it becomes virtual and therefore open to any kind of stepper motor by using the suitable driver.

This C++ library contains a set of classes for controlling different stepper motors:

• Add a list item per library class with a brief explanation of its features

At a glance

Insert here short yet clarifying examples of each library class to get a quick idea of its features

Getting started

First, download the library source files from the latest release available and install them locally by following the tutorial Installing Additional Arduino Libraries, specifically as explained in the sections "Importing a .zip library" or "Manual installation".

Once installed locally, you can download and test any of the examples contained in the examples directory.

Finally, you can get detailed information of every class by reading the references contained in the directory docs/classes.

Repository structure

This repository is structured in these directories:

• /docs: It contains the library documentation, as classes references and datasheets.
• /examples: It contains usage examples of each class. It is a good place for getting a quick idea regarding what this library can do for you.
• /src: It contains the library source code.

Contributions to the project

In case you were interested in participating in this project, read CONTRIBUTING.md for further information.

Questions and answers

Last, but not least, if you have a question just ask it in the Discussions Questions & Answers category. Don't be shy, exposing questions is also a way of collaborating with the project: many good ideas start with a good question.

Attributions and references

• The documentation badges are generated by shields.io.
• The tables of contents are generated with the Online GitHub Wiki TOC generator.
• The library follows the coding style defined by the Google ++ Style Guide.