upload
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.

GettingStarted.txt 2.1KB

12345678910111213141516171819202122232425262728293031323334353637
  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. /** \page Page_GettingStarted Getting Started
  7. *
  8. * Getting started with LUFA is easy; read the content below to get on your way to your first LUFA powered application.
  9. *
  10. * \section Sec_DemosOverview The LUFA Demo Applications
  11. *
  12. * Out of the box, LUFA contains a large number of pre-made class demos for you to test, experiment with and
  13. * ultimately build upon for your own projects. All the demos (where possible) come pre-configured to build and
  14. * run correctly on the AT90USB1287 AVR microcontroller, mounted on the Atmel USBKEY board and running at an 8MHz
  15. * master clock. This is due to two reasons; one, it is the hardware the author possesses, and two, it is the most
  16. * popular Atmel USB demonstration board to date. To learn how to reconfigure, recompile and program the included
  17. * LUFA applications using different settings, see the subsections below.
  18. *
  19. * \section Sec_ClassOrLowLevel Class Driver and Low Level Demos
  20. *
  21. * Most of the included demos in the /Demos/ folder come in both ClassDriver and LowLevel varieties. If you are new
  22. * to LUFA, it is highly recommended that you look at the ClassDriver versions first, which use the pre-made USB
  23. * Class Drivers (\ref Group_USBClassDrivers) to simplify the use of the standard USB classes in user applications.
  24. * These demos give a basic but easy to use interface to the USB class used in the demo application, such as HID or
  25. * CDC.
  26. *
  27. * Those needing absolute control over the class implementation can look at the LowLevel demos, which implement the
  28. * required USB class directly in the demo application using the lowest level LUFA APIs.
  29. *
  30. *
  31. * <b>Subsections:</b>
  32. * \li \subpage Page_ConfiguringApps - How to Configure the Included Demos, Projects and Bootloaders
  33. * \li \subpage Page_CompilingApps - How to Compile the Included Demos, Projects and Bootloaders
  34. * \li \subpage Page_ProgrammingApps - How to Program an AVR with the Included Demos, Projects and Bootloaders
  35. */