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.

56 lines
2.4 KiB

  1. _ _ _ ___ _
  2. | | | | | __/ \
  3. | |_| U | _| o | - The Lightweight USB
  4. |___|___|_||_n_| Framework for AVRs
  5. =========================================
  6. Written by Dean Camera
  7. dean [at] fourwalledcubicle [dot] com
  8. http://www.lufa-lib.org
  9. =========================================
  10. LUFA is donation supported. To support LUFA,
  11. please donate at http://www.lufa-lib.org/donate
  12. Released under a modified MIT license - see
  13. LUFA/License.txt for license details.
  14. For Commercial Licensing information, see
  15. http://www.lufa-lib.org/license
  16. This package contains the complete LUFA library, demos, user-submitted
  17. projects and bootloaders for use with compatible microcontroller models.
  18. LUFA is a simple to use, lightweight framework which sits atop the hardware
  19. USB controller in specific AVR microcontroller models, and allows for the
  20. quick and easy creation of complex USB devices and hosts.
  21. To get started, you will need to install the "Doxygen" documentation
  22. generation tool. If you use Linux, this can be installed via the "doxygen"
  23. package in your chosen package management tool - under Ubuntu, this can be
  24. achieved by running the following command in the terminal:
  25. sudo apt-get install doxygen
  26. Other package managers and distributions will have similar methods to
  27. install Doxygen. In Windows, you can download a prebuilt installer for
  28. Doxygen from its website, www.doxygen.org.
  29. Once installed, you can then use the Doxygen tool to generate the library
  30. documentation from the command line or terminal of your operating system. To
  31. do this, open your terminal or command line to the root directory of the
  32. LUFA package, and type the following command:
  33. make doxygen
  34. Which will recursively generate documentation for all elements in the
  35. library - the core, plus all demos, projects and bootloaders. Generated
  36. documentation will then be available by opening the file "index.html" of the
  37. created Documentation/html/ subdirectories inside each project folder.
  38. The documentation for the library itself (but not the documentation for the
  39. individual demos, projects or bootloaders) is also available as a separate
  40. package from the project webpage for convenience if Doxygen cannot be
  41. installed.