MainPage.txt 2.08 KB
Newer Older
1
2
3
4
5
6
7
/** \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.
 */

/**
8
 *  \mainpage
9
 *
10
11
12
 *  \n
 *  \image html LUFA.gif "The Lightweight USB Framework for AVRs"
 *  \n
13
 *
14
15
16
 *  For author and donation information, see \ref Page_Donating.
 *
 *  Originally based on the AT90USBKEY from Atmel, LUFA is an open-source USB library for the USB-enabled AVR
17
 *  microcontrollers, released under the MIT license. It now supports a large number of USB AVR models and boards.
18
19
20
21
22
23
24
25
26
27
28
 *
 *  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, check out my blog.
 *
 *  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.
 *
 *  The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory.
 *  If this directory is missing, please re-download the project from the project homepage.
 *
29
30
31
32
 *  Also included with the library are three fully functional bootloaders, located in the /Bootloaders/ subdirectory.
 *  The DFU class bootloader is compatible with Atmel's FLIP software or the open source dfu-programmer project, the
 *  CDC class (AVR109 protocol) is compatible with such open source software as AVRDUDE and AVR-OSP, and the TeensyLoader
 *  HID class bootloader is compatible with the software from PJRC (http://www.pjrc.com/teensy/index.html).
33
 *
34
35
36
 *  User-submitted projects are located in the /Projects/ subdirectory. If you wish to have your LUFA project included,
 *  please email it to the Library author.
 *
37
38
39
 *  <b>Subsections:</b>
 *  - \subpage Page_Licence Project License
 *  - \subpage Page_Donating Donating to Support this Project
40
41
42
 *
 *
 *  <small><i>Logo design by Pavla Dlab</i></small>
43
 */