diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-15 13:57:57 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-15 13:57:57 +0000 |
| commit | ab76c52e1414c55a2f594999ca2a04918bbc7143 (patch) | |
| tree | 5c840ac7122d8338aa10723b4fa255c8a16317a7 /LUFA/ManPages/MainPage.txt | |
| parent | 84d77833503151acffbdda6217fa8ce59c6b4b8a (diff) | |
| download | lufa-ab76c52e1414c55a2f594999ca2a04918bbc7143.tar.gz lufa-ab76c52e1414c55a2f594999ca2a04918bbc7143.tar.bz2 lufa-ab76c52e1414c55a2f594999ca2a04918bbc7143.zip | |
Move main library documentation pages into a new ManPages subdirectory.
Diffstat (limited to 'LUFA/ManPages/MainPage.txt')
| -rw-r--r-- | LUFA/ManPages/MainPage.txt | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/LUFA/ManPages/MainPage.txt b/LUFA/ManPages/MainPage.txt new file mode 100644 index 000000000..b326f5cd5 --- /dev/null +++ b/LUFA/ManPages/MainPage.txt @@ -0,0 +1,34 @@ +/** \file
+ *
+ * This file contains special DoxyGen information for the generation of the main page and other special
+ * documentation pages. It is not a project source file.
+ */
+
+/**
+ * \mainpage General Information
+ *
+ * Lightweight USB Framework for AVRs Library, written by Dean Camera.
+ *
+ * Originally based on the AT90USBKEY from Atmel, it is an open-source USB library for the USB-enabled AVR
+ * microcontrollers, released under the MIT license. It now supports a large number of USB AVR models and boards.
+ *
+ * The library is currently in a stable release, suitable for download and incorporation into user projects for
+ * both host and device modes. For information about the project progression, check out my blog.
+ *
+ * LUFA is written specifically for the free AVR-GCC compiler, and uses several GCC-only extensions to make the
+ * library API more streamlined and robust. You can download AVR-GCC for free in a convenient windows package,
+ * from the the WinAVR website.
+ *
+ * \section Sec_Demos Demos and Bootloaders
+ * The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory.
+ * If this directory is missing, please re-download the project from the project homepage.
+ *
+ * Also included with the library are three fully functional bootloaders, located in the /Bootloaders/ subdirectory.
+ * The DFU class bootloader is compatible with Atmel's FLIP software or the open source dfu-programmer project, the
+ * CDC class (AVR109 protocol) is compatible with such open source software as AVRDUDE and AVR-OSP, and the TeensyLoader
+ * HID class bootloader is compatible with the software from PJRC (http://www.pjrc.com/teensy/index.html).
+ *
+ * <b>Subsections:</b>
+ * - \subpage Page_Licence Project License
+ * - \subpage Page_Donating Donating to Support this Project
+ */
|