Open-source keyboard firmware for Atmel AVR and Arm USB families Including hardware based encryption
Go to file
Dean Camera 3ae9e6042f Cache the USB_DeviceState variable internally in the library core when multiple checks are required in a single loop iteration, to reduce compiled code size. 2010-10-06 10:16:02 +00:00
Bootloaders Reverted Endpoint/Pipe non-sequential configuration hack, placed restriction on the configuration order instead to ensure maximum reliability. 2010-09-30 06:23:38 +00:00
Demos Fixed LowLevel JoystickHostWithParser demo not saving the chosen HID interface's report descriptor size. 2010-10-01 12:01:54 +00:00
LUFA Cache the USB_DeviceState variable internally in the library core when multiple checks are required in a single loop iteration, to reduce compiled code size. 2010-10-06 10:16:02 +00:00
Projects Revert change to the AVRISP-MKII project for fuse byte programming via the CMDEX bit - this appears to be an error in the XMEGA manual external memory programming table. 2010-10-02 10:07:24 +00:00
LUFA.pnproj Added board hardware driver support for the Arduino Uno development board. 2010-09-28 14:30:26 +00:00
README.txt Spell check all source files once again to find any typos. 2010-07-29 16:20:45 +00:00
makefile Add svn:eol-style property to source files, so that the line endings are correctly converted to the target system's native end of line style. 2010-05-08 03:12:14 +00:00

README.txt

                   _   _ _ ___ _  
                  | | | | | __/ \ 
                  | |_| U | _| o | - The Lightweight USB
                  |___|___|_||_n_|    Framework for AVRs
                =========================================
                          Written by Dean Camera
                  dean [at] fourwalledcubicle [dot] com

                 http://www.fourwalledcubicle.com/LUFA.php
                =========================================

               LUFA is donation supported. To support LUFA, 
             please donate at http://www.fourwalledcubicle.com.

                For Commercial Licensing information, see
               http://fourwalledcubicle.com/PurchaseLUFA.php


This package contains the complete LUFA library, demos, user-submitted
projects and bootloaders for use with compatible microcontroller models.
LUFA is a simple to use, lightweight framework which sits atop the hardware
USB controller in specific AVR microcontroller models, and allows for the
quick and easy creation of complex USB devices and hosts.

To get started, you will need to install the "Doxygen" documentation
generation tool. If you use Linux, this can be installed via the "doxygen"
package in your chosen package management tool - under Ubuntu, this can be
achieved by running the following command in the terminal:

   sudo apt-get install doxygen
	
Other package managers and distributions will have similar methods to
install Doxygen. In Windows, you can download a prebuilt installer for
Doxygen from its website, www.doxygen.org.

Once installed, you can then use the Doxygen tool to generate the library
documentation from the command line or terminal of your operating system. To
do this, open your terminal or command line to the root directory of the
LUFA package, and type the following command:

   make doxygen

Which will recursively generate documentation for all elements in the
library - the core, plus all demos, projects and bootloaders. Generated
documentation will then be available by opening the file "index.html" of the
created Documentation/html/ subdirectories inside each project folder.

The documentation for the library itself (but not the documentation for the
individual demos, projects or bootloaders) is also available as a separate
package from the project webpage for convenience if Doxygen cannot be
installed.