MainPage.txt 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  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. * \mainpage
  8. *
  9. * \image html Images/LUFA.png
  10. * <div align="center"><small><i>Logo design by <a href="http://www.studiomonsoon.com">Studio Monsoon Photography</a></i></small></div>
  11. * \n
  12. * <div align="center"><a href="http://www.lufa-lib.org">http://www.lufa-lib.org</a></div>
  13. * \n
  14. *
  15. * <b>LUFA is donationware. For author and donation information, see \ref Page_Donating.</b>
  16. *
  17. * LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license (see \ref Page_LicenseInfo).
  18. * It supports a large number of USB AVR models and boards (see \ref Page_DeviceSupport). It is designed to provide an easy to use,
  19. * feature rich framework for the development of USB peripherals and hosts.
  20. *
  21. * LUFA focuses on the microcontroller side of USB development only; it includes no PC host USB driver development facilities - other projects
  22. * such as the Windows Driver Development Kit, Windows USB Device Mode Framework and libusb may be of interest for developing custom OS drivers.
  23. * While custom USB devices can be made with LUFA using such tools, the included demos all use the inbuilt OS drivers for each USB class for
  24. * simplicity.
  25. *
  26. * The library is currently in a stable release, suitable for download and incorporation into user projects for
  27. * both host and device modes. For information about the project progression, see the blog link at \ref Page_Resources.
  28. *
  29. * LUFA is written specifically for the free AVR-GCC compiler, and uses several GCC-only extensions to make the
  30. * library API more streamlined and robust. You can download AVR-GCC for free in a convenient windows package,
  31. * from the the WinAVR website (see \ref Page_Resources).
  32. *
  33. * The only required AVR peripherals for LUFA is the USB controller itself and interrupts - LUFA does not require the use of the
  34. * microcontroller's timers or other hardware, leaving more hardware to the application developer.
  35. *
  36. * Accompanying LUFA in the download package is a set of example demo applications, plus several Bootloaders of different classes
  37. * and open source LUFA powered projects.
  38. *
  39. * <b>Subsections:</b>
  40. * \li \subpage Page_LicenseInfo - Project source license and commercial use information
  41. * \li \subpage Page_Donating - Donating to support this project
  42. * \li \subpage Page_DeviceSupport - Current Device and Hardware Support
  43. * \li \subpage Page_ChangeLog - Project Changelog
  44. * \li \subpage Page_KnownIssues - Known Issues
  45. * \li \subpage Page_FutureChanges - Planned Changes to the Library
  46. * \li \subpage Page_GettingStarted - Getting started with LUFA
  47. * \li \subpage Page_DevelopingWithLUFA - Developing with LUFA
  48. * \li \subpage Page_LUFAPoweredProjects - Other Projects Using LUFA
  49. * \li \subpage Page_Resources - LUFA and USB Related Resources
  50. */