X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/39d07c3da045a3d739f9977101f8a81f0b8ff0e1..d11ed10c5314c44dc01c06954d1d73d4894cbff8:/LUFA/ManPages/MainPage.txt?ds=sidebyside diff --git a/LUFA/ManPages/MainPage.txt b/LUFA/ManPages/MainPage.txt index a9cfa7641..c7ea7db1b 100644 --- a/LUFA/ManPages/MainPage.txt +++ b/LUFA/ManPages/MainPage.txt @@ -5,33 +5,41 @@ */ /** - * \mainpage General Information + * \mainpage * - * Lightweight USB Framework for AVRs Library, written by Dean Camera. + * \n + * \image html LUFA.gif + * \n * - * 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. + * LUFA is donationware. For author and donation information, see \ref Page_Donating. + * + * LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license. 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 host USB driver development facilities. While + * custom USB devices can be made with LUFA, 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, check out my blog. + * 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. - * - * \section Sec_Demos Demos, Projects 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. + * from the the WinAVR website (see \ref Page_Resources). * - * 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). + * 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. * - * User-submitted projects are located in the /Projects/ subdirectory. If you wish to have your LUFA project included, - * please email it to the Library author. + * 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. * * Subsections: - * - \subpage Page_Licence Project License - * - \subpage Page_Donating Donating to Support this Project + * - \subpage Page_WhyUseLUFA Why Use LUFA? + * - \subpage Page_LUFAvsAtmelStack How does LUFA compare to the Atmel USB AVR stack? + * - \subpage Page_AlternativeStacks Alternative USB AVR Stacks + * - \subpage Page_Licence Project licence + * - \subpage Page_Donating Donating to support this project + * - \subpage Page_LibraryApps Overview of included Demos, Bootloaders and Projects + * + * Logo design by EDIGMA.COM */