diff options
Diffstat (limited to 'lib/lufa/LUFA/DoxygenPages/GettingStarted.txt')
| -rw-r--r-- | lib/lufa/LUFA/DoxygenPages/GettingStarted.txt | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/lib/lufa/LUFA/DoxygenPages/GettingStarted.txt b/lib/lufa/LUFA/DoxygenPages/GettingStarted.txt new file mode 100644 index 000000000..9ceec1e04 --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/GettingStarted.txt | |||
| @@ -0,0 +1,37 @@ | |||
| 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 | /** \page Page_GettingStarted Getting Started | ||
| 8 | * | ||
| 9 | * Getting started with LUFA is easy; read the content below to get on your way to your first LUFA powered application. | ||
| 10 | * | ||
| 11 | * \section Sec_DemosOverview The LUFA Demo Applications | ||
| 12 | * | ||
| 13 | * Out of the box, LUFA contains a large number of pre-made class demos for you to test, experiment with and | ||
| 14 | * ultimately build upon for your own projects. All the demos (where possible) come pre-configured to build and | ||
| 15 | * run correctly on the AT90USB1287 AVR microcontroller, mounted on the Atmel USBKEY board and running at an 8MHz | ||
| 16 | * master clock. This is due to two reasons; one, it is the hardware the author possesses, and two, it is the most | ||
| 17 | * popular Atmel USB demonstration board to date. To learn how to reconfigure, recompile and program the included | ||
| 18 | * LUFA applications using different settings, see the subsections below. | ||
| 19 | * | ||
| 20 | * \section Sec_ClassOrLowLevel Class Driver and Low Level Demos | ||
| 21 | * | ||
| 22 | * Most of the included demos in the /Demos/ folder come in both ClassDriver and LowLevel varieties. If you are new | ||
| 23 | * to LUFA, it is highly recommended that you look at the ClassDriver versions first, which use the pre-made USB | ||
| 24 | * Class Drivers (\ref Group_USBClassDrivers) to simplify the use of the standard USB classes in user applications. | ||
| 25 | * These demos give a basic but easy to use interface to the USB class used in the demo application, such as HID or | ||
| 26 | * CDC. | ||
| 27 | * | ||
| 28 | * Those needing absolute control over the class implementation can look at the LowLevel demos, which implement the | ||
| 29 | * required USB class directly in the demo application using the lowest level LUFA APIs. | ||
| 30 | * | ||
| 31 | * | ||
| 32 | * <b>Subsections:</b> | ||
| 33 | * \li \subpage Page_ConfiguringApps - How to Configure the Included Demos, Projects and Bootloaders | ||
| 34 | * \li \subpage Page_CompilingApps - How to Compile the Included Demos, Projects and Bootloaders | ||
| 35 | * \li \subpage Page_ProgrammingApps - How to Program an AVR with the Included Demos, Projects and Bootloaders | ||
| 36 | */ | ||
| 37 | |||
