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                 For Commercial Licensing information, see
  17                      http://www.lufa-lib.org/license
  18
  19
  20 This package contains the complete LUFA library, demos, user-submitted
  21 projects and bootloaders for use with compatible microcontroller models.
  22 LUFA is a simple to use, lightweight framework which sits atop the hardware
  23 USB controller in specific AVR microcontroller models, and allows for the
  24 quick and easy creation of complex USB devices and hosts.
  25
  26 To get started, you will need to install the "Doxygen" documentation
  27 generation tool. If you use Linux, this can be installed via the "doxygen"
  28 package in your chosen package management tool - under Ubuntu, this can be
  29 achieved by running the following command in the terminal:
  30
  31    sudo apt-get install doxygen
  32
  33 Other package managers and distributions will have similar methods to
  34 install Doxygen. In Windows, you can download a prebuilt installer for
  35 Doxygen from its website, www.doxygen.org.
  36
  37 Once installed, you can then use the Doxygen tool to generate the library
  38 documentation from the command line or terminal of your operating system. To
  39 do this, open your terminal or command line to the root directory of the
  40 LUFA package, and type the following command:
  41
  42    make doxygen
  43
  44 Which will recursively generate documentation for all elements in the
  45 library - the core, plus all demos, projects and bootloaders. Generated
  46 documentation will then be available by opening the file "index.html" of the
  47 created Documentation/html/ subdirectories inside each project folder.
  48
  49 The documentation for the library itself (but not the documentation for the
  50 individual demos, projects or bootloaders) is also available as a separate
  51 package from the project webpage for convenience if Doxygen cannot be
  52 installed.
  53