tmk_core/protocol/lufa/LUFA-120730/README.txt

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