Change over unix line-endings to dos line endings.

[pub/lufa.git] / LUFA / ManPages / MainPage.txt

diff --git a/LUFA/ManPages/MainPage.txt b/LUFA/ManPages/MainPage.txt
index a9cfa76..c67ba64 100644 (file)
--- a/LUFA/ManPages/MainPage.txt
+++ b/LUFA/ManPages/MainPage.txt
@@ -5,33 +5,41 @@
  */\r
 \r
 /**\r
  */\r
 \r
 /**\r

- *  \mainpage General Information\r
+ *  \mainpage\r

  *\r
  *\r

- *  Lightweight USB Framework for AVRs Library, written by Dean Camera. \r
+ *  \image html LUFA.png\r
+ *  <div align="center"><small><i>Logo design by <b>Ryo</b> - http://ryophotography.wordpress.com</i></small></div>\r
+ *  \n\r

  *\r
  *\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
+ *  <b>LUFA is donationware. For author and donation information, see \ref Page_Donating.</b>\r
+ *\r
+ *  LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license (see \ref Page_LicenceInfo).\r
+ *  It supports a large number of USB AVR models and boards (see \ref Page_DeviceSupport). It is designed to provide an easy to use,\r
+ *  feature rich framework for the development of USB peripherals and hosts.\r
+ *\r
+ *  LUFA focuses on the microcontroller side of USB development only; it includes no PC host USB driver development facilities - other projects\r
+ *  such as the Windows Driver Development Kit, Windows USB Device Mode Framework and libusb may be of interest for developing custom OS drivers.\r
+ *  While custom USB devices can be made with LUFA using such tools, the included demos all use the inbuilt OS drivers for each USB class for\r
+ *  simplicity.\r

  *\r
  *  The library is currently in a stable release, suitable for download and incorporation into user projects for\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
+ *  both host and device modes. For information about the project progression, see the blog link at \ref Page_Resources.\r

  *\r
  *  LUFA is written specifically for the free AVR-GCC compiler, and uses several GCC-only extensions to make the\r
  *  library API more streamlined and robust. You can download AVR-GCC for free in a convenient windows package, \r
  *\r
  *  LUFA is written specifically for the free AVR-GCC compiler, and uses several GCC-only extensions to make the\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
- *  \section Sec_Demos Demos, Projects 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
+ *  from the the WinAVR website (see \ref Page_Resources).\r

  *\r
  *\r

- *  Also included with the library are three fully functional bootloaders, located in the /Bootloaders/ subdirectory.\r
- *  The DFU class bootloader is compatible with Atmel's FLIP software or the open source dfu-programmer project, the\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
+ *  The only required AVR peripherals for LUFA is the USB controller itself and interrupts - LUFA does not require the use of the\r
+ *  microcontroller's timers or other hardware, leaving more hardware to the application developer.\r

  *\r
  *\r

- *  User-submitted projects are located in the /Projects/ subdirectory. If you wish to have your LUFA project included,\r
- *  please email it to the Library author.\r
+ *  Accompanying LUFA in the download package is a set of example demo applications, plus several Bootloaders of different classes\r
+ *  and open source LUFA powered projects.\r

  *\r
  *  <b>Subsections:</b>\r
  *\r
  *  <b>Subsections:</b>\r

- *  - \subpage Page_Licence Project License\r
- *  - \subpage Page_Donating Donating to Support this Project\r
+ *  - \subpage Page_WhyUseLUFA What are the advantages of using LUFA?\r
+ *  - \subpage Page_LUFAvsAtmelStack How does LUFA compare to the Atmel USB AVR stack?\r
+ *  - \subpage Page_AlternativeStacks Alternative USB AVR Stacks\r
+ *  - \subpage Page_LicenceInfo Project source licence and commercial use information\r
+ *  - \subpage Page_Donating Donating to support this project\r
+ *  - \subpage Page_LibraryApps Overview of included Demos, Bootloaders and Projects\r

  */\r
  */\r