LUFA/ManPages/GettingStarted.txt

   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  *  Out of the box, LUFA contains a large number of pre-made class demos for you to test, experiment with and
  10  *  ultimately build upon for your own projects. All the demos (where possible) come pre-configured to build and
  11  *  run correctly on the AT90USB1287 AVR microcontroller, mounted on the Atmel USBKEY board and running at an 8MHz
  12  *  master clock. This is due to two reasons; one, it is the hardware the author possesses, and two, it is the most
  13  *  popular Atmel USB demonstration board to date. To learn how to reconfigure, recompile and program the included
  14  *  LUFA applications using different settings, see the subsections below.
  15  *
  16  *  For an overview of the included library applications, bootloaders and demos, see \ref Page_LibraryApps.
  17  *
  18  *  <b>Subsections:</b>
  19  *  - \subpage Page_ConfiguringApps How to Configure the Included Demos, Projects and Bootloaders
  20  *  - \subpage Page_CompilingApps How to Compile the Included Demos, Projects and Bootloaders
  21  *  - \subpage Page_ProgrammingApps How to Program an AVR with the Included Demos, Projects and Bootloaders
  22  */