protocol/lufa/LUFA-120730/LUFA/DoxygenPages/GettingStarted.txt

   1 /** \file\r
   2  *\r
   3  *  This file contains special DoxyGen information for the generation of the main page and other special\r
   4  *  documentation pages. It is not a project source file.\r
   5  */\r
   6 \r
   7 /** \page Page_GettingStarted Getting Started\r
   8  *\r
   9  *  Out of the box, LUFA contains a large number of pre-made class demos for you to test, experiment with and\r
  10  *  ultimately build upon for your own projects. All the demos (where possible) come pre-configured to build and\r
  11  *  run correctly on the AT90USB1287 AVR microcontroller, mounted on the Atmel USBKEY board and running at an 8MHz\r
  12  *  master clock. This is due to two reasons; one, it is the hardware the author possesses, and two, it is the most\r
  13  *  popular Atmel USB demonstration board to date. To learn how to reconfigure, recompile and program the included\r
  14  *  LUFA applications using different settings, see the subsections below.\r
  15  *\r
  16  *  Most of the included demos in the /Demos/ folder come in both ClassDriver and LowLevel varieties. If you are new\r
  17  *  to LUFA, it is highly recommended that you look at the ClassDriver versions first, which use the pre-made USB\r
  18  *  Class Drivers (\ref Group_USBClassDrivers) to simplify the use of the standard USB classes in user applications.\r
  19  *\r
  20  *  <b>Subsections:</b>\r
  21  *  \li \subpage Page_ConfiguringApps - How to Configure the Included Demos, Projects and Bootloaders\r
  22  *  \li \subpage Page_CompilingApps - How to Compile the Included Demos, Projects and Bootloaders\r
  23  *  \li \subpage Page_ProgrammingApps - How to Program an AVR with the Included Demos, Projects and Bootloaders\r
  24  */\r
  25 \r