summaryrefslogtreecommitdiff
path: root/firmware/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'firmware/README.txt')
-rw-r--r--firmware/README.txt53
1 files changed, 53 insertions, 0 deletions
diff --git a/firmware/README.txt b/firmware/README.txt
new file mode 100644
index 0000000..f90b1f0
--- /dev/null
+++ b/firmware/README.txt
@@ -0,0 +1,53 @@
+Dependencies
+------------
+
+gcc-avr binutils-avr gdb-avr avr-libc avrdude make git
+
+To install all dependencies, run:
+make deps
+
+Fuse Settings
+-------------
+
+Fuse settings are defined in the Makefile as follows:
+
+LFUSE = 0xFF
+HFUSE = 0xD9
+EFUSE = 0xFF
+LOCK = 0xFF
+
+System Reset
+------------
+
+To exclusively execute a soft reset, run:
+make reset
+
+Firmware Compilation
+--------------------
+
+To exclusively build the firmware, run:
+make build
+
+Firmware Flash
+--------------
+
+To exclusively execute a firmware flash, run:
+make flash
+
+Usage
+-----
+
+Only two commands are required to build and flash
+the firmware onto the ATmega328P.
+
+Simply run:
+make
+
+Then run:
+make upload
+
+Note:
+
+If you encounter issues performing a soft reset, use:
+make force-upload
+