protocol/lufa/LUFA-120730/LUFA/DoxygenPages/MainPage.txt

   1 /** \file\r
   2  *\r
   3  *  This file contains special DoxyGen information for the generation of the main page and other special\r
   4  *  documentation pages. It is not a project source file.\r
   5  */\r
   6 \r
   7 /**\r
   8  *  \mainpage\r
   9  *\r
  10  *  \image html Images/LUFA.png\r
  11  *  <div align="center"><small><i>Logo design by <a href="http://www.studiomonsoon.com">Studio Monsoon Photography</a></i></small></div>\r
  12  *  \n\r
  13  *  <div align="center"><a href="http://www.lufa-lib.org">http://www.lufa-lib.org</a></div>\r
  14  *  \n\r
  15  *\r
  16  *  <b>LUFA is donationware. For author and donation information, see \ref Page_Donating.</b>\r
  17  *\r
  18  *  LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license (see \ref Page_LicenseInfo).\r
  19  *  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
  20  *  feature rich framework for the development of USB peripherals and hosts.\r
  21  *\r
  22  *  LUFA focuses on the microcontroller side of USB development only; it includes no PC host USB driver development facilities - other projects\r
  23  *  such as the Windows Driver Development Kit, Windows USB Device Mode Framework and libusb may be of interest for developing custom OS drivers.\r
  24  *  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
  25  *  simplicity.\r
  26  *\r
  27  *  The library is currently in a stable release, suitable for download and incorporation into user projects for\r
  28  *  both host and device modes. For information about the project progression, see the blog link at \ref Page_Resources.\r
  29  *\r
  30  *  LUFA is written specifically for the free AVR-GCC compiler, and uses several GCC-only extensions to make the\r
  31  *  library API more streamlined and robust. You can download AVR-GCC for free in a convenient windows package,\r
  32  *  from the the WinAVR website (see \ref Page_Resources).\r
  33  *\r
  34  *  The only required AVR peripherals for LUFA is the USB controller itself and interrupts - LUFA does not require the use of the\r
  35  *  microcontroller's timers or other hardware, leaving more hardware to the application developer.\r
  36  *\r
  37  *  Accompanying LUFA in the download package is a set of example demo applications, plus several Bootloaders of different classes\r
  38  *  and open source LUFA powered projects.\r
  39  *\r
  40  *  <b>Subsections:</b>\r
  41  *  \li \subpage Page_LicenseInfo - Project source license and commercial use information\r
  42  *  \li \subpage Page_Donating - Donating to support this project\r
  43  *  \li \subpage Page_DeviceSupport - Current Device and Hardware Support\r
  44  *  \li \subpage Page_ChangeLog - Project Changelog\r
  45  *  \li \subpage Page_KnownIssues - Known Issues\r
  46  *  \li \subpage Page_FutureChanges - Planned Changes to the Library\r
  47  *  \li \subpage Page_GettingStarted - Getting started with LUFA\r
  48  *  \li \subpage Page_DevelopingWithLUFA - Developing with LUFA\r
  49  *  \li \subpage Page_LUFAPoweredProjects - Other Projects Using LUFA\r
  50  *  \li \subpage Page_Resources - LUFA and USB Related Resources\r
  51  */\r
  52 \r