README.txt

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