qmk_firmware

Open-source keyboard firmware for Atmel AVR and Arm USB families Including hardware based encryption

Go to file

Dean Camera 710f31c540 Added new NO_CLASS_DRIVER_AUTOFLUSH compile time option to disable automatic flushing of interfaces when the USB management tasks for each driver is called. The MIDI class drivers now automatically flushes the MIDI interface when the MIDI class driver's USBTask() function is called.		2010-10-27 07:23:51 +00:00
Bootloaders	Add descriptor class, subclass and protocol constants to the class drivers, modify all demos to use them where possible.	2010-10-25 12:42:55 +00:00
Demos	Changed AudioInput and AudioOutput demos to reload the next sample via an interrupt rather than polling the sample timer.	2010-10-26 06:52:09 +00:00
LUFA	Added new NO_CLASS_DRIVER_AUTOFLUSH compile time option to disable automatic flushing of interfaces when the USB management tasks for each driver is called.	2010-10-27 07:23:51 +00:00
Projects	Add descriptor class, subclass and protocol constants to the class drivers, modify all demos to use them where possible.	2010-10-25 12:42:55 +00:00
LUFA.pnproj	Add descriptor class, subclass and protocol constants to the class drivers, modify all demos to use them where possible.	2010-10-25 12:42:55 +00:00
README.txt	Clean up excessive whitespace at the end of each line using the wspurify tool made by Laszlo Monda	2010-10-13 14:05:35 +00:00
makefile	Clean up excessive whitespace at the end of each line using the wspurify tool made by Laszlo Monda	2010-10-13 14:05:35 +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.