Add missing project files for the new HIDReportViewer project to upgrade its status...
[pub/USBasp.git] / LUFA / ManPages / MainPage.txt
index a9cfa76..f18a6a2 100644 (file)
@@ -1,37 +1,48 @@
-/** \file\r
- *\r
- *  This file contains special DoxyGen information for the generation of the main page and other special\r
- *  documentation pages. It is not a project source file.\r
- */\r
-\r
-/**\r
- *  \mainpage General Information\r
- *\r
- *  Lightweight USB Framework for AVRs Library, written by Dean Camera. \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
- *\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
- *\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
- *\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
- *\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
- *\r
- *  <b>Subsections:</b>\r
- *  - \subpage Page_Licence Project License\r
- *  - \subpage Page_Donating Donating to Support this Project\r
- */\r
+/** \file
+ *
+ *  This file contains special DoxyGen information for the generation of the main page and other special
+ *  documentation pages. It is not a project source file.
+ */
+
+/**
+ *  \mainpage
+ *
+ *  \image html LUFA.png
+ *  <div align="center"><small><i>Logo design by <a href="http://ryophotography.wordpress.com">Ryo Photography</a></i></small></div>
+ *  \n
+ *  <div align="center"><a href="http://www.lufa-lib.org">http://www.lufa-lib.org</a></div>
+ *  \n
+ *
+ *  <b>LUFA is donationware. For author and donation information, see \ref Page_Donating.</b>
+ *
+ *  LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license (see \ref Page_LicenseInfo).
+ *  It supports a large number of USB AVR models and boards (see \ref Page_DeviceSupport). It is designed to provide an easy to use,
+ *  feature rich framework for the development of USB peripherals and hosts.
+ *
+ *  LUFA focuses on the microcontroller side of USB development only; it includes no PC host USB driver development facilities - other projects
+ *  such as the Windows Driver Development Kit, Windows USB Device Mode Framework and libusb may be of interest for developing custom OS drivers.
+ *  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
+ *  simplicity.
+ *
+ *  The library is currently in a stable release, suitable for download and incorporation into user projects for
+ *  both host and device modes. For information about the project progression, see the blog link at \ref Page_Resources.
+ *
+ *  LUFA is written specifically for the free AVR-GCC compiler, and uses several GCC-only extensions to make the
+ *  library API more streamlined and robust. You can download AVR-GCC for free in a convenient windows package,
+ *  from the the WinAVR website (see \ref Page_Resources).
+ *
+ *  The only required AVR peripherals for LUFA is the USB controller itself and interrupts - LUFA does not require the use of the
+ *  microcontroller's timers or other hardware, leaving more hardware to the application developer.
+ *
+ *  Accompanying LUFA in the download package is a set of example demo applications, plus several Bootloaders of different classes
+ *  and open source LUFA powered projects.
+ *
+ *  <b>Subsections:</b>
+ *  \li \subpage Page_WhyUseLUFA - What are the advantages of using LUFA?
+ *  \li \subpage Page_LUFAvsAtmelStack - How does LUFA compare to the Atmel USB AVR stack?
+ *  \li \subpage Page_AlternativeStacks - Alternative USB AVR Stacks
+ *  \li \subpage Page_LicenseInfo - Project source license and commercial use information
+ *  \li \subpage Page_Donating - Donating to support this project
+ *  \li \subpage Page_LibraryApps - Overview of included Demos, Bootloaders and Projects
+ */
+