Browse Source

+ updated readme

SG 3 years ago
parent
commit
7b2f0c08ac
1 changed files with 8 additions and 6 deletions
  1. 8 6
      README.md

+ 8 - 6
README.md

@@ -1,14 +1,16 @@
-Contains two projects:
+# ActuBoard v1.1
 
-1) ActuBoard Firmware
+The ActuBoard Project is structured as followed:
+
+1. ActuBoard Firmware
 	C++ firmware for the ESP32 and the ActuBoard specific hardware (Controller + Hubs). Also provide the serial communication interface on hardware side, as well as the addressing of each Hub port through I2C.
 
-2) ActuBoard API
-	2.1) ActuBoard Interface
+2. ActuBoard API
+	2.1. ActuBoard Interface
 		Unity compatible C# library for serial communication with ActuBoard. Can be imported easily as DLL in own projects.
 		
-	2.2) ActuBoard Console
+	2.2. ActuBoard Console
 		Debugging tool that relies on the ActuBoard Interface. Good to test commands without having a project ready. Also, includes a terminal-like output which makes Putty or similar not necessary.
 		
-3) Schematics
+3. Schematics
 	Contains schematics, renderings, list of commands and everything necessary to rebuild ActuBoard.