Added new Host mode Audio Class driver.

[pub/lufa.git] / Bootloaders / HID / BootloaderHID.txt

diff --git a/Bootloaders/HID/BootloaderHID.txt b/Bootloaders/HID/BootloaderHID.txt
index 9b47ff3..d695822 100644 (file)
--- a/Bootloaders/HID/BootloaderHID.txt
+++ b/Bootloaders/HID/BootloaderHID.txt
@@ -48,12 +48,31 @@
  *\r
  *  This bootloader enumerates to the host as a HID Class device, allowing for device FLASH programming through\r
  *  the supplied command line software, which is a modified version of Paul's TeensyHID Command Line loader code\r
- *  from PJRC, used with permission. This bootloader is delibertely non-compatible with the properietary HalfKay\r
- *  bootloader GUI; only the command line interface software accompanying this bootloader will work with it.\r
+ *  from PJRC (used with permission). This bootloader is deliberatley non-compatible with the properietary PJRC\r
+ *  HalfKay bootloader GUI; only the command line interface software accompanying this bootloader will work with it.\r
  *  \r
- *  Out of the box this bootloader builds for the USB1287, and will fit into 4KB of bootloader space. If\r
- *  you wish to enlarge this space and/or change the AVR model, you will need to edit the BOOT_START and MCU\r
- *  values in the accompanying makefile.\r
+ *  Out of the box this bootloader builds for the USB1287, and will fit into 2KB of bootloader space for the\r
+ *  Series 2 USB AVRs (ATMEGAxxU2, AT90USBxx2) or 4KB of bootloader space for all other models. If you wish to\r
+ *  enlarge this space and/or change the AVR model, you will need to edit the BOOT_START and MCU values in the\r
+ *  accompanying makefile.\r
+ *\r
+ *  \section Sec_Installation Driver Installation\r
+ *\r
+ *  This bootloader uses the HID class driver inbuilt into all modern operating systems, thus no additional drivers\r
+ *  need to be supplied for correct operation.\r
+ *\r
+ *  \section Sec_HostApp Host Controller Application\r
+ *\r
+ *  Due to licensing issues, the supplied bootloader is compatible with the HalfKay bootloader protocol designed\r
+ *  by PJRC, but is non-compatible with the cross-platform loader GUI. A modified version of the open source\r
+ *  cross-platform TeensyLoader application is supplied, which can be compiled under most operating systems. The\r
+ *  command-line loader application should remain compatible with genuine Teensy boards in addition to boards using\r
+ *  this custom bootloader.\r
+ *\r
+ *  Once compiled, programs can be loaded into the AVR's FLASH memory through the following example command:\r
+ *  \code\r
+ *  hid_bootloader_cli -mmcu=at90usb1287 Mouse.hex\r
+ *  \endcode\r
  *\r
  *  \section SSec_Options Project Options\r
  *\r