Merge pull request #114 from ethanlefebv/doc

Merge new doc into main
ethanlefebv · Apr 16, 2021 · 33e5dc7 · 33e5dc7
2 parents 9932bbc + 3fc9025
commit 33e5dc7
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/main/README.md b/main/README.md
@@ -0,0 +1,14 @@
+# _main_ folder
+This folder contains all the C++ code that runs on the OpenCR. The purpose of the different files is [described here](#files) and a diagram of the [program structure](#program-structure) is also shown.
+
+## Files
+- __actuators.cpp__ : This file contains all the functions to control the robot's movements (motors and solenoids).
+- __comm_functions.cpp__ : This file contains all the functions required for the communication with the Raspberry Pi over the Serial port.
+- __inverse_kinematics.cpp__ : This file contains the math functions to convert a 2D coordinate to motor angles.
+- __nut.h__ : This file contains the definition of the Nut type.
+- __main.ino__ : This is the main sketch file (main program for the OpenCR).
+
+## Program structure
+The following image shows the main structure of the program running on the Raspberry Pi and the progam running on the OpenCR.
+
+![image](program_structure.png "Image")
diff --git a/main/program_structure.png b/main/program_structure.png