diff options
author | Trygve Laugstøl <trygvis@inamo.no> | 2012-03-25 17:46:26 +0200 |
---|---|---|
committer | Trygve Laugstøl <trygvis@inamo.no> | 2012-03-25 17:46:26 +0200 |
commit | d0703775221dc25613f6b81cbe151b54db6cc66c (patch) | |
tree | bcc69080702cef20a2779e019499dc19307f4883 /firmware/LUFA/ManPages/GettingStarted.txt | |
download | bitraf-fridge-rev-a.tar.gz bitraf-fridge-rev-a.tar.bz2 bitraf-fridge-rev-a.tar.xz bitraf-fridge-rev-a.zip |
Board, rev A.rev-a
Diffstat (limited to 'firmware/LUFA/ManPages/GettingStarted.txt')
-rw-r--r-- | firmware/LUFA/ManPages/GettingStarted.txt | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/firmware/LUFA/ManPages/GettingStarted.txt b/firmware/LUFA/ManPages/GettingStarted.txt new file mode 100644 index 0000000..ab460cb --- /dev/null +++ b/firmware/LUFA/ManPages/GettingStarted.txt @@ -0,0 +1,27 @@ +/** \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. + * + * For an overview of the included library applications, bootloaders and demos, see \ref Page_LibraryApps. + * + * <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 + */ + |