Added build instructions
authorJoseph Coffland <joseph@cauldrondevelopment.com>
Wed, 30 Dec 2015 02:48:07 +0000 (18:48 -0800)
committerJoseph Coffland <joseph@cauldrondevelopment.com>
Wed, 30 Dec 2015 02:48:07 +0000 (18:48 -0800)
README.md

index ab297fe3591909884c014c116a9be2d3f60a7131..7b1e78ded2bbaa48abccb720c506d8e594b7d61b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,6 +7,21 @@ TinyG is a 6 axis motion control system designed for high-performance on small t
 * XON/XOFF and RTS/CTS protocol over USB serial
 * RESTful interface using JSON
 
+# Build Instructions
+To build in Linux run:
+
+    make
+
+Other make commands are:
+
+ * **size** - Display program and data sizes
+ * **program** - program using AVR dude and an avrispmkII
+ * **erase** - Erase chip
+ * **fuses** - Write AVR fuses bytes
+ * **read_fuses** - Read and pring AVR fuse bytes
+ * **clean** - Remove build files
+ * **tidy** - Remove backup files
+
 # Links
 * [TinyG Wiki](https://github.com/synthetos/TinyG/wiki)
 * [TinyG Support Forum](https://www.synthetos.com/forum/tinyg/)