aboutsummaryrefslogtreecommitdiffstats
path: root/firmware/e300/battery/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'firmware/e300/battery/README.md')
-rw-r--r--firmware/e300/battery/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/firmware/e300/battery/README.md b/firmware/e300/battery/README.md
new file mode 100644
index 000000000..fc4d504dd
--- /dev/null
+++ b/firmware/e300/battery/README.md
@@ -0,0 +1,25 @@
+USRP E312 Firmware
+==================
+
+Welcome to the NI Ettus Research USRP E310/E312 Firmware distribution.
+
+# Dependencies
+
+In order to build you'll *avr-gcc* and *avr-libc*.
+
+# Building
+
+The included Makefile specifies all the required flags. To build type:
+```
+$ make
+```
+
+# Flashing
+
+In order to program the device with the firmware type:
+```
+$ make install
+```
+
+Note: The Makefile will have to be modified depending on which programmer you use.
+Known good programmers include 'Atmel AVR Dragon, Atmel JTAGICEIII, Atmel AtmelICE'.