LUFA/ManPages/MainPage.txt

   1 /** \file
   2  *
   3  *  This file contains special DoxyGen information for the generation of the main page and other special
   4  *  documentation pages. It is not a project source file.
   5  */
   6
   7 /**
   8  *  \mainpage
   9  *
  10  *  \image html LUFA.png
  11  *  <div align="center"><small><i>Logo design by <b>Ryo Yamauchi</b></i></small></div>
  12  *  \n
  13  *
  14  *  <b>LUFA is donationware. For author and donation information, see \ref Page_Donating.</b>
  15  *
  16  *  LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license (see \ref Page_Licence).
  17  *  It supports a large number of USB AVR models and boards (see \ref Page_DeviceSupport). It is designed to provide an easy to use,
  18  *  feature rich framework for the development of USB peripherals and hosts.
  19  *
  20  *  LUFA focuses on the microcontroller side of USB development only; it includes no host USB driver development facilities. While
  21  *  custom USB devices can be made with LUFA, the included demos all use the inbuilt OS drivers for each USB class for simplicity.
  22  *
  23  *  The library is currently in a stable release, suitable for download and incorporation into user projects for
  24  *  both host and device modes. For information about the project progression, see the blog link at \ref Page_Resources.
  25  *
  26  *  LUFA is written specifically for the free AVR-GCC compiler, and uses several GCC-only extensions to make the
  27  *  library API more streamlined and robust. You can download AVR-GCC for free in a convenient windows package,
  28  *  from the the WinAVR website (see \ref Page_Resources).
  29  *
  30  *  The only required AVR peripherals for LUFA is the USB controller itself and interrupts - LUFA does not require the use of the
  31  *  microcontroller's timers or other hardware, leaving more hardware to the application developer.
  32  *
  33  *  Accompanying LUFA in the download package is a set of example demo applications, plus several Bootloaders of different classes
  34  *  and open source LUFA powered projects.
  35  *
  36  *  <b>Subsections:</b>
  37  *  - \subpage Page_WhyUseLUFA What are the advantages of using LUFA?
  38  *  - \subpage Page_LUFAvsAtmelStack How does LUFA compare to the Atmel USB AVR stack?
  39  *  - \subpage Page_AlternativeStacks Alternative USB AVR Stacks
  40  *  - \subpage Page_Licence Project source licence and commercial use information
  41  *  - \subpage Page_Donating Donating to support this project
  42  *  - \subpage Page_LibraryApps Overview of included Demos, Bootloaders and Projects
  43  */