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 General Information
   9  *
  10  *  Lightweight USB Framework for AVRs Library, written by Dean Camera.
  11  *
  12  *  Originally based on the AT90USBKEY from Atmel, it is an open-source USB library for the USB-enabled AVR
  13  *  microcontrollers, released under the MIT license. It now supports a large number of USB AVR models and boards.
  14  *
  15  *  The library is currently in a stable release, suitable for download and incorporation into user projects for
  16  *  both host and device modes. For information about the project progression, check out my blog.
  17  *
  18  *  LUFA is written specifically for the free AVR-GCC compiler, and uses several GCC-only extensions to make the
  19  *  library API more streamlined and robust. You can download AVR-GCC for free in a convenient windows package,
  20  *  from the the WinAVR website.
  21  *
  22  *  \section Sec_Demos Demos, Projects and Bootloaders
  23  *  The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory.
  24  *  If this directory is missing, please re-download the project from the project homepage.
  25  *
  26  *  Also included with the library are three fully functional bootloaders, located in the /Bootloaders/ subdirectory.
  27  *  The DFU class bootloader is compatible with Atmel's FLIP software or the open source dfu-programmer project, the
  28  *  CDC class (AVR109 protocol) is compatible with such open source software as AVRDUDE and AVR-OSP, and the TeensyLoader
  29  *  HID class bootloader is compatible with the software from PJRC (http://www.pjrc.com/teensy/index.html).
  30  *
  31  *  User-submitted projects are located in the /Projects/ subdirectory. If you wish to have your LUFA project included,
  32  *  please email it to the Library author.
  33  *
  34  *  <b>Subsections:</b>
  35  *  - \subpage Page_Licence Project License
  36  *  - \subpage Page_Donating Donating to Support this Project
  37  */