diff options
| author | tmk <hasu@tmk-kbd.com> | 2015-05-13 04:13:10 +0200 |
|---|---|---|
| committer | tmk <hasu@tmk-kbd.com> | 2015-05-13 04:13:10 +0200 |
| commit | f6d56675f9f981c5464f0ca7a1fbb0162154e8c5 (patch) | |
| tree | 57c9d4b3808a26116ae0ee7956fc00b84841aa2b /protocol/lufa/LUFA-git/LUFA/DoxygenPages/GettingStarted.txt | |
| parent | 4d116a04e94cf0d19317d5b44e4fa9f34a3e5594 (diff) | |
| download | qmk_firmware-f6d56675f9f981c5464f0ca7a1fbb0162154e8c5.tar.gz qmk_firmware-f6d56675f9f981c5464f0ca7a1fbb0162154e8c5.tar.xz | |
Squashed 'tmk_core/' changes from caca2c0..dc0e46e
dc0e46e Rename LUFA to LUFA-git
3bfa7fa Remove LUFA-120730
215b764 Merge commit 'afa0f22a9299686fd88f58ce09c5b521ac917e8f' as 'protocol/lufa/LUFA'
afa0f22 Squashed 'protocol/lufa/LUFA/' content from commit def7fca
c0c42fa Remove submodule of LUFA
30f897d Merge commit '87ced33feb74e79c3281dda36eb6d6d153399b41' as 'protocol/usb_hid/USB_Host_Shield_2.0'
87ced33 Squashed 'protocol/usb_hid/USB_Host_Shield_2.0/' content from commit aab4a69
14f6d49 Remove submodule of USB_Host_Shield_2.0
git-subtree-dir: tmk_core
git-subtree-split: dc0e46eaa4367d4e218f8816e3c117895820f07c
Diffstat (limited to 'protocol/lufa/LUFA-git/LUFA/DoxygenPages/GettingStarted.txt')
| -rw-r--r-- | protocol/lufa/LUFA-git/LUFA/DoxygenPages/GettingStarted.txt | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/protocol/lufa/LUFA-git/LUFA/DoxygenPages/GettingStarted.txt b/protocol/lufa/LUFA-git/LUFA/DoxygenPages/GettingStarted.txt new file mode 100644 index 000000000..9ceec1e04 --- /dev/null +++ b/protocol/lufa/LUFA-git/LUFA/DoxygenPages/GettingStarted.txt @@ -0,0 +1,37 @@ +/** \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 + * + * Getting started with LUFA is easy; read the content below to get on your way to your first LUFA powered application. + * + * \section Sec_DemosOverview The LUFA Demo Applications + * + * 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. + * + * \section Sec_ClassOrLowLevel Class Driver and Low Level Demos + * + * 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. + * These demos give a basic but easy to use interface to the USB class used in the demo application, such as HID or + * CDC. + * + * Those needing absolute control over the class implementation can look at the LowLevel demos, which implement the + * required USB class directly in the demo application using the lowest level LUFA APIs. + * + * + * <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 + */ + |