qmk_firmware/protocol/lufa/LUFA-120730/LUFA/DoxygenPages/GettingStarted.txt

26 lines
1.6 KiB
Plaintext
Raw Normal View History

2013-02-11 13:57:40 +00:00
/** \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.
*/
/** \page Page_GettingStarted Getting Started
*
* Out of the box, LUFA contains a large number of pre-made class demos for you to test, experiment with and
* ultimately build upon for your own projects. All the demos (where possible) come pre-configured to build and
* run correctly on the AT90USB1287 AVR microcontroller, mounted on the Atmel USBKEY board and running at an 8MHz
* master clock. This is due to two reasons; one, it is the hardware the author possesses, and two, it is the most
* popular Atmel USB demonstration board to date. To learn how to reconfigure, recompile and program the included
* LUFA applications using different settings, see the subsections below.
*
* Most of the included demos in the /Demos/ folder come in both ClassDriver and LowLevel varieties. If you are new
* to LUFA, it is highly recommended that you look at the ClassDriver versions first, which use the pre-made USB
* Class Drivers (\ref Group_USBClassDrivers) to simplify the use of the standard USB classes in user applications.
*
* <b>Subsections:</b>
* \li \subpage Page_ConfiguringApps - How to Configure the Included Demos, Projects and Bootloaders
* \li \subpage Page_CompilingApps - How to Compile the Included Demos, Projects and Bootloaders
* \li \subpage Page_ProgrammingApps - How to Program an AVR with the Included Demos, Projects and Bootloaders
*/