qmk_firmware

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

Go to file

Dean Camera b181cf4fb8 Minor documentation improvements.		2012-05-20 15:35:01 +00:00
Bootloaders	Upgrade Doxygen configuration files for Doxygen 1.8.1, fix broken stylesheet and footer HTML, add explicit spacing into documentation code fragments to prevent Doxygen from removing empty lines in the output.	2012-05-20 10:55:59 +00:00
BuildTests	Add missing CPPCheck unusedFunction check suppressions on the USB template functions.	2012-05-19 22:14:06 +00:00
Demos	Additional fixes to the MIDI host driver due to not unfreezing/re-freezing pipes correctly (thanks to Michael Brown).	2012-05-20 13:04:26 +00:00
LUFA	Minor documentation improvements.	2012-05-20 15:35:01 +00:00
Maintenance	Update project Doxygen and makefiles so that the resulting project documentation hides the unused version value, and uses the same HTML CSS stylesheet as the library core.	2012-05-17 21:08:53 +00:00
Projects	Added new RESET_TOGGLES_LIBUSB_COMPAT compile time option to the AVRISP-MKII clone programmer project (thanks to Robert Spitzenpfeil).	2012-05-20 15:34:47 +00:00
LUFA.pnproj	Fix incorrectly names build test directory references.	2012-05-13 13:11:04 +00:00
README.txt	Changed over www.fourwalledcubicle.com links to the new www.lufa-lib.org redirect domain, including the new aliased links for LUFA-related pages such as the various download/source control mirrors and support lists.	2010-10-28 06:08:58 +00:00
makefile	Update build test "ModuleTest" to check platform drivers where possible. Add missing copyright/license headers.	2012-02-19 13:30:08 +00:00

README.txt

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

                         http://www.lufa-lib.org
                =========================================

               LUFA is donation supported. To support LUFA,
             please donate at http://www.lufa-lib.org/donate

                For Commercial Licensing information, see
                     http://www.lufa-lib.org/license


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.