aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/DoxygenPages/MainPage.txt
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2011-10-18 11:35:04 +0000
committerDean Camera <dean@fourwalledcubicle.com>2011-10-18 11:35:04 +0000
commite9029d49d5455ec146d2e87436d43d747d6c657a (patch)
tree42b1785f6f849079a14d3b1f41b45d75ec16aceb /LUFA/DoxygenPages/MainPage.txt
parent3aa8a69246942c27a389950caad0374ffb3e6056 (diff)
downloadlufa-e9029d49d5455ec146d2e87436d43d747d6c657a.tar.gz
lufa-e9029d49d5455ec146d2e87436d43d747d6c657a.tar.bz2
lufa-e9029d49d5455ec146d2e87436d43d747d6c657a.zip
Rename the Doxygen page source directory from ManPages/ to DoxygenPages/ to prevent user confusion with the actual *nix Man tool.
Diffstat (limited to 'LUFA/DoxygenPages/MainPage.txt')
-rw-r--r--LUFA/DoxygenPages/MainPage.txt48
1 files changed, 48 insertions, 0 deletions
diff --git a/LUFA/DoxygenPages/MainPage.txt b/LUFA/DoxygenPages/MainPage.txt
new file mode 100644
index 000000000..0ab9d56dc
--- /dev/null
+++ b/LUFA/DoxygenPages/MainPage.txt
@@ -0,0 +1,48 @@
+/** \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
+ *
+ * \image html LUFA.png
+ * <div align="center"><small><i>Logo design by <a href="http://www.studiomonsoon.com">Studio Monsoon Photography</a></i></small></div>
+ * \n
+ * <div align="center"><a href="http://www.lufa-lib.org">http://www.lufa-lib.org</a></div>
+ * \n
+ *
+ * <b>LUFA is donationware. For author and donation information, see \ref Page_Donating.</b>
+ *
+ * LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license (see \ref Page_LicenseInfo).
+ * It supports a large number of USB AVR models and boards (see \ref Page_DeviceSupport). It is designed to provide an easy to use,
+ * feature rich framework for the development of USB peripherals and hosts.
+ *
+ * LUFA focuses on the microcontroller side of USB development only; it includes no PC host USB driver development facilities - other projects
+ * such as the Windows Driver Development Kit, Windows USB Device Mode Framework and libusb may be of interest for developing custom OS drivers.
+ * While custom USB devices can be made with LUFA using such tools, the included demos all use the inbuilt OS drivers for each USB class for
+ * simplicity.
+ *
+ * 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, see the blog link at \ref Page_Resources.
+ *
+ * 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 (see \ref Page_Resources).
+ *
+ * The only required AVR peripherals for LUFA is the USB controller itself and interrupts - LUFA does not require the use of the
+ * microcontroller's timers or other hardware, leaving more hardware to the application developer.
+ *
+ * Accompanying LUFA in the download package is a set of example demo applications, plus several Bootloaders of different classes
+ * and open source LUFA powered projects.
+ *
+ * <b>Subsections:</b>
+ * \li \subpage Page_WhyUseLUFA - What are the advantages of using LUFA?
+ * \li \subpage Page_LUFAvsAtmelStack - How does LUFA compare to the Atmel USB AVR stack?
+ * \li \subpage Page_AlternativeStacks - Alternative USB AVR Stacks
+ * \li \subpage Page_LicenseInfo - Project source license and commercial use information
+ * \li \subpage Page_Donating - Donating to support this project
+ * \li \subpage Page_LibraryApps - Overview of included Demos, Bootloaders and Projects
+ */
+