Use sub pages in main library documentation to improve readability.
[pub/lufa.git] / LUFA / MainPage.txt
index 2ff8b0c..b326f5c 100644 (file)
@@ -5,33 +5,12 @@
  */\r
 \r
 /**\r
- *  \mainpage About the LUFA (Formerly MyUSB) Library\r
+ *  \mainpage General Information\r
  *\r
- *  Lightweight USB Framework for AVRs Library, written by Dean Camera.\r
+ *  Lightweight USB Framework for AVRs Library, written by Dean Camera. \r
  *\r
- *  \section Sec_About About this library\r
- *\r
- *  Originally based on the AT90USBKEY from Atmel, it is an open-source, driver for the USB-enabled AVR\r
- *  microcontrollers, released under the MIT license.\r
- *\r
- *  Currently supported AVR models:\r
- *   - AT90USB1286 (USB Device Only)\r
- *   - AT90USB1287 (USB Host and Device)\r
- *   - AT90USB646 (USB Device Only)\r
- *   - AT90USB647 (USB Host and Device)\r
- *   - AT90USB82 (USB Device Only)\r
- *   - AT90USB162 (USB Device Only)\r
- *   - ATMEGA16U4 (USB Device Only)\r
- *   - ATMEGA32U4 (USB Device Only)\r
- *   - ATMEGA32U6 (USB Device Only)\r
- *\r
- *  Currently supported Atmel boards:\r
- *   - AT90USBKEY\r
- *   - STK525\r
- *   - STK526\r
- *   - RZUSBSTICK\r
- *   - ATAVRUSBRF01\r
- *   - Custom User Boards\r
+ *  Originally based on the AT90USBKEY from Atmel, it is an open-source USB library for the USB-enabled AVR\r
+ *  microcontrollers, released under the MIT license. It now supports a large number of USB AVR models and boards.\r
  *\r
  *  The library is currently in a stable release, suitable for download and incorporation into user projects for\r
  *  both host and device modes. For information about the project progression, check out my blog.\r
  *  library API more streamlined and robust. You can download AVR-GCC for free in a convenient windows package, \r
  *  from the the WinAVR website.\r
  *\r
- *\r
- *  \section Sec_Links Library Links\r
- *  Project Homepage: http://www.fourwalledcubicle.com/LUFA.php \n\r
- *  Development Blog: http://www.fourwalledcubicle.com/blog \n\r
- *  Discussion Group: http://groups.google.com/group/myusb-support-list \n\r
- *  SVN Access, Bug Reports and Feature Requests: http://code.google.com/p/lufa-lib/ \n\r
- *  Author's Website: http://www.fourwalledcubicle.com \n\r
- *\r
- *  WinAVR Website: http://winavr.sourceforge.net \n\r
- *  avr-libc Website: http://www.nongnu.org/avr-libc/ \n\r
- *\r
- *  USB-IF Website: http://www.usb.org \n\r
- *\r
- *\r
- *  \section Sec_License License\r
- *  The LUFA library is currently released under the MIT licence, included below.\r
- *\r
- *  Commercial entities can opt out of the public disclosure clause in this license\r
- *  for a one-time US$1500 payment. This provides a non-exclusive modified MIT licensed which\r
- *  allows for the free use of the LUFA library, bootloaders and (where the sole copyright\r
- *  is attributed to Dean Camera) demos without public disclosure within an organisation. Please\r
- *  contact the author for more information.\r
- *\r
- *  \verbatim\r
- *  Permission to use, copy, modify, and distribute this software\r
- *  and its documentation for any purpose and without fee is hereby\r
- *  granted, provided that the above copyright notice appear in all\r
- *  copies and that both that the copyright notice and this\r
- *  permission notice and warranty disclaimer appear in supporting\r
- *  documentation, and that the name of the author not be used in\r
- *  advertising or publicity pertaining to distribution of the\r
- *  software without specific, written prior permission.\r
- *\r
- *  The author disclaim all warranties with regard to this\r
- *  software, including all implied warranties of merchantability\r
- *  and fitness.  In no event shall the author be liable for any\r
- *  special, indirect or consequential damages or any damages\r
- *  whatsoever resulting from loss of use, data or profits, whether\r
- *  in an action of contract, negligence or other tortious action,\r
- *  arising out of or in connection with the use or performance of\r
- *  this software.\r
- *  \endverbatim\r
- *\r
- *\r
  *  \section Sec_Demos Demos and Bootloaders\r
  *  The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory.\r
  *  If this directory is missing, please re-download the project from the project homepage.\r
  *  CDC class (AVR109 protocol) is compatible with such open source software as AVRDUDE and AVR-OSP, and the TeensyLoader\r
  *  HID class bootloader is compatible with the software from PJRC (http://www.pjrc.com/teensy/index.html).\r
  *\r
- *\r
- *  \section Sec_Donations Donate\r
- *  I am a 20 year old University student studying for a double degree in Computer Science and Electronics Engineering.\r
- *  The development and support of this library requires much effort from myself. Please consider donating a small amount\r
- *  to myself to support this and my future Open Source projects. You can donate any amount via PayPal on my website, \r
- *  http://www.fourwalledcubicle.com . All donations are greatly appreciated.\r
+ *  <b>Subsections:</b>\r
+ *  - \subpage Page_Licence Project License\r
+ *  - \subpage Page_Donating Donating to Support this Project\r
  */\r
\r