X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/c1a1b6eeecb375259968ef6d989833312047f2d8..d26a9ed5fd6fc60a0dfa61d04f5ae2bd7163a85d:/Bootloaders/CDC/BootloaderCDC.txt?ds=sidebyside

diff --git a/Bootloaders/CDC/BootloaderCDC.txt b/Bootloaders/CDC/BootloaderCDC.txt
index cb6f9f01f..4f48a6eac 100644
--- a/Bootloaders/CDC/BootloaderCDC.txt
+++ b/Bootloaders/CDC/BootloaderCDC.txt
@@ -5,36 +5,68 @@
  */
  
 /** \mainpage CDC Class USB AVR Bootloader
- * 
- * This bootloader enumerates to the host as a CDC Class device (virtual serial port), allowing for AVR109
- * protocol compatible programming software to load firmware onto the AVR.	
+ *
+ *  \section SSec_Compat Demo Compatibility:
+ *
+ *  The following list indicates what microcontrollers are compatible with this demo.
+ *
+ *  - Series 7 USB AVRs
+ *  - Series 6 USB AVRs
+ *  - Series 4 USB AVRs
+ *  - Series 2 USB AVRs
+ *
+ *  \section SSec_Info USB Information:
+ *
+ *  The following table gives a rundown of the USB utilization of this demo.
+ *
+ *  <table>
+ *   <tr>
+ *    <td><b>USB Mode:</b></td>
+ *    <td>Device</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>USB Class:</b></td>
+ *    <td>Communications Device Class (CDC)</td>
+ *   </tr>
+ *   <tr> 
+ *    <td><b>USB Subclass:</b></td>
+ *    <td>Abstract Control Model (ACM)</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Relevant Standards:</b></td>
+ *    <td>USBIF CDC Class Standard</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Usable Speeds:</b></td>
+ *    <td>Full Speed Mode</td>
+ *   </tr>
+ *  </table>
+ *
+ *  \section SSec_Description Project Description: 
+ *
+ *  This bootloader enumerates to the host as a CDC Class device (virtual serial port), allowing for AVR109
+ *  protocol compatible programming software to load firmware onto the AVR.	
  *  
- * Out of the box this bootloader builds for the USB1287, and will fit into 4KB of bootloader space. If
- * you wish to enlarge this space and/or change the AVR model, you will need to edit the BOOT_START and MCU
- * values in the accompanying makefile.
+ *  Out of the box this bootloader builds for the USB1287, and will fit into 4KB of bootloader space. If
+ *  you wish to enlarge this space and/or change the AVR model, you will need to edit the BOOT_START and MCU
+ *  values in the accompanying makefile.
  *  
- * This bootloader is compatible with the open source application AVRDUDE, or Atmel's AVRPROG.
- *
- * <table>
- *  <tr>
- *   <td><b>USB Mode:</b></td>
- *   <td>Device</td>
- *  </tr>
- *  <tr>
- *   <td><b>USB Class:</b></td>
- *   <td>Communications Device Class (CDC)</td>
- *  </tr>
- *  <tr> 
- *   <td><b>USB Subclass:</b></td>
- *   <td>Abstract Control Model (ACM)</td>
- *  </tr>
- *  <tr>
- *   <td><b>Relevant Standards:</b></td>
- *   <td>USBIF CDC Class Standard</td>
- *  </tr>
- *  <tr>
- *   <td><b>Usable Speeds:</b></td>
- *   <td>Full Speed Mode</td>
- *  </tr>
- * </table>
- */
+ *  This bootloader is compatible with the open source application AVRDUDE, or Atmel's AVRPROG.
+ *
+ *  After running this bootloader for the first time on a new computer, you will need to supply the .INF
+ *  file located in this bootloader project's directory as the device's driver when running under Windows.
+ *  This will enable Windows to use its inbuilt CDC drivers, negating the need for custom drivers for the
+ *  device. Other Operating Systems should automatically use their own inbuilt CDC-ACM drivers.
+ *
+ *  \section SSec_Options Project Options
+ *
+ *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
+ *
+ *  <table>
+ *   <tr>
+ *    <td><b>Define Name:</b></td>
+ *    <td><b>Location:</b></td>
+ *    <td><b>Description:</b></td>
+ *   </tr>
+ *  </table>
+ */
\ No newline at end of file