diff options
author | tmk <hasu@tmk-kbd.com> | 2015-04-10 01:32:04 +0900 |
---|---|---|
committer | tmk <hasu@tmk-kbd.com> | 2015-04-10 01:32:04 +0900 |
commit | 1a02ebcc612e9a9c0d87e02295c7258de3a70ccc (patch) | |
tree | e517f3c70bb2d542797e57d13e9023c84af230fb /tmk_core/protocol/lufa/LUFA-120730/LUFA/DoxygenPages/GettingStarted.txt | |
parent | 6746e37088ce8ba03529c1226bd216705edb2b1f (diff) | |
parent | a074364c3731d66b56d988c8a6c960a83ea0e0a1 (diff) | |
download | firmware-1a02ebcc612e9a9c0d87e02295c7258de3a70ccc.tar.gz firmware-1a02ebcc612e9a9c0d87e02295c7258de3a70ccc.tar.bz2 firmware-1a02ebcc612e9a9c0d87e02295c7258de3a70ccc.zip |
Merge commit 'a074364c3731d66b56d988c8a6c960a83ea0e0a1' as 'tmk_core'
Diffstat (limited to 'tmk_core/protocol/lufa/LUFA-120730/LUFA/DoxygenPages/GettingStarted.txt')
-rw-r--r-- | tmk_core/protocol/lufa/LUFA-120730/LUFA/DoxygenPages/GettingStarted.txt | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/tmk_core/protocol/lufa/LUFA-120730/LUFA/DoxygenPages/GettingStarted.txt b/tmk_core/protocol/lufa/LUFA-120730/LUFA/DoxygenPages/GettingStarted.txt new file mode 100644 index 000000000..b62a7cae1 --- /dev/null +++ b/tmk_core/protocol/lufa/LUFA-120730/LUFA/DoxygenPages/GettingStarted.txt @@ -0,0 +1,25 @@ +/** \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
+ */
+
|