MainPage.txt 1.87 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
 *  For author and donation information, see \ref Page_Donating.
 *
16
 *  LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license. It supports
Dean Camera's avatar
Dean Camera committed
17
18
19
20
21
 *  a large number of USB AVR models and boards (see \ref Page_DeviceSupport). It is designed to provide an easy to use, feature
 *  rich framework for the development of USB peripherals and hosts.
 *
 *  LUFA focuses on the microcontroller side of USB development only; it includes no host USB driver development facilities. While
 *  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
24
25
26
27
28
29
 *
 *  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.
 *
30
31
 *  Accompanying LUFA in the download package is a set of example demo applications, plus several Bootloaders (DFU, CDC and HID
 *  class) and open source LUFA powered projects.
32
 *
33
 *  <b>Subsections:</b>
34
 *  - \subpage Page_Licence Project licence
35
 *  - \subpage Page_Donating Donating to Support this Project
36
 *  - \subpage Page_LibraryApps Overview of included Demos, Bootloaders and Projects
37
38
39
 *
 *
 *  <small><i>Logo design by Pavla Dlab</i></small>
40
 */