diff options
| author | tmk <hasu@tmk-kbd.com> | 2015-04-10 01:32:04 +0900 |
|---|---|---|
| committer | tmk <hasu@tmk-kbd.com> | 2015-04-10 01:32:04 +0900 |
| commit | 1a02ebcc612e9a9c0d87e02295c7258de3a70ccc (patch) | |
| tree | e517f3c70bb2d542797e57d13e9023c84af230fb /tmk_core/protocol/lufa/LUFA-120730/README.txt | |
| parent | 6746e37088ce8ba03529c1226bd216705edb2b1f (diff) | |
| parent | a074364c3731d66b56d988c8a6c960a83ea0e0a1 (diff) | |
Merge commit 'a074364c3731d66b56d988c8a6c960a83ea0e0a1' as 'tmk_core'
Diffstat (limited to 'tmk_core/protocol/lufa/LUFA-120730/README.txt')
| -rw-r--r-- | tmk_core/protocol/lufa/LUFA-120730/README.txt | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/tmk_core/protocol/lufa/LUFA-120730/README.txt b/tmk_core/protocol/lufa/LUFA-120730/README.txt new file mode 100644 index 0000000000..aacb4af9ae --- /dev/null +++ b/tmk_core/protocol/lufa/LUFA-120730/README.txt @@ -0,0 +1,56 @@ +
+ _ _ _ ___ _
+ | | | | | __/ \
+ | |_| 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
+
+ Released under a modified MIT license - see
+ LUFA/License.txt for license details.
+
+ 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.
+
|