Add firmware for the ATUSB IEEE 802.15.4 USB Adapter
[linux-libre-firmware.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index b6eb4a4a54076e6fd810f9c598e71615f38b333e..7fb111653d0885c3086970712c53adb08527bbfd 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -16,6 +16,8 @@ In order to build everything you will need the following on the host
 system:
 
     * A C/C++ compiler, like GCC
+    * AVR-GCC
+    * Standard C library for AVR-GCC
     * Cmake
     * GNU Bison/YACC
     * GNU Flex
@@ -32,16 +34,31 @@ system:
 
 On GNU/Linux distros that use apt you can install these with:
 
-    apt install binutils-arm-linux-gnueabi binutils-arm-none-eabi bison \
-    cmake flex g++ gcc gcc-arm-linux-gnueabi gcc-arm-none-eabi gperf make wget
+    apt install avr-gcc avr-libc binutils-arm-linux-gnueabi \
+    binutils-arm-none-eabi bison cmake flex g++ gcc \
+    gcc-arm-linux-gnueabi gcc-arm-none-eabi gperf make wget
 
 CARL9170 Firmware Configuration
+-------------------------------
 When building the carl9170 firmware you will be prompted with
 configuration questions.
 
------
-Copyright (C) 2017, 2018 Jason Self <j@jxself.org>
-Copying and distribution of this file, with or without modification,
-are permitted in any medium without royalty provided the copyright
-notice and this notice are preserved. This file is offered as-is,
-without any warranty.
\ No newline at end of file
+atusb: Firmware for the ATUSB IEEE 802.15.4 USB Adapter
+-------------------------------------------------------
+
+To flash the firmware you need dfu-util on the host. Issue
+
+    make dfu
+
+right after plugging the device into the USB port while the red led is
+still on.
+
+Refer to the included README file for more information.
+
+Licensing
+---------
+
+You can redistribute and/or modify this file under the terms of the
+GNU General Public License as published by the Free Software
+Foundation, either version 3 of the License, or (at your option) any
+later version.
\ No newline at end of file