> pip install -r requirements.txt
> python -m unittest discover -s tests
For any work that needs to be done on the project make an issue describing the what needs to be done and use tags to identify the type of work it is.
If you would like to work on an issue please assign it to yourself. Then create a new local branch on your machine where you are going to work on the code and make all your changes for the issue there.
Every new function must have a test associated with it in the /tests directory
in the according file. If a file for the piece of code you are testing has not
been created then create one using the convetion test_{module name}.py.
Push your branch to the repo and then create a pull request. Assign
ece-jacob-scott as a reviewer.
All code related to the Arduino lives in the Arduino folder and each sketch has it's own folder.
Python code lives in the project root directory for now. Later if needed we can move more modules to their own folders if the code requires a higher level of organization.
The STL files for the footpedal live within the STL_Files folder. Each pedal is the same so everything will need to be printed twice. The Pot_holder.stl is the part that holds the potentiometers for the pitch and roll axis so it will need to be printed 4 times (two for each foot). The Full_Design.stl is the stl file that shows the final configuration for one pedal.