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