From 312748702a0f87f79c6e86745d3699d09a91778c Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Tue, 14 Jul 2009 07:33:06 +0000 Subject: Added better module summaries. --- LUFA/ManPages/FutureChanges.txt | 3 --- LUFA/ManPages/LUFAPoweredProjects.txt | 1 + LUFA/ManPages/LibraryApps.txt | 8 +++++--- LUFA/ManPages/MainPage.txt | 6 +++++- LUFA/ManPages/ProgrammingApps.txt | 2 +- 5 files changed, 12 insertions(+), 8 deletions(-) (limited to 'LUFA/ManPages') diff --git a/LUFA/ManPages/FutureChanges.txt b/LUFA/ManPages/FutureChanges.txt index 651afcbbc..6d052a745 100644 --- a/LUFA/ManPages/FutureChanges.txt +++ b/LUFA/ManPages/FutureChanges.txt @@ -19,15 +19,12 @@ * -# Re-enable Host mode Class driver builds after completion * -# Update Host mode Class Driver demo .txt files * - Add standardized descriptor names to device and host class driver structures - * - Add in INTERRUPT_CONTROL_PIPE to use HSOFI to trigger calls to the host state machine - * - Debug mode for pipe/endpoint calls * * Targeted for Future Releases: * - Remake AVRStudio project files * - Add detailed overviews of how each demo works * - Master LUFA include file rather than per-module includes * - Stream reads - return number of bytes not read? - * - Convert CDC demos to use stdio streams? * - Add multiple-report HID demo to the library * - Add dual role Mouse Host/Keyboard Device demo to the library * - Add hub support to match Atmel's stack diff --git a/LUFA/ManPages/LUFAPoweredProjects.txt b/LUFA/ManPages/LUFAPoweredProjects.txt index c15911a01..68e6fb619 100644 --- a/LUFA/ManPages/LUFAPoweredProjects.txt +++ b/LUFA/ManPages/LUFAPoweredProjects.txt @@ -34,6 +34,7 @@ * - CAMTRIG, a remote Camera Trigger device: http://code.astraw.com/projects/motmot/camtrig * - Opendous-JTAG, an open source JTAG device: http://code.google.com/p/opendous-jtag/ * - Openkubus, an open source hardware-based authentication dongle: http://code.google.com/p/openkubus/ + * - Orbee, a USB connected RGB Orb for notifications: http://www.franksworkshop.com.au/Electronics/Orbee/Orbee.htm * - Reprap with LUFA, a LUFA powered 3D printer: http://code.google.com/p/at90usb1287-code-for-arduino-and-eclipse/ * - SEGA Megadrive/Genesis Development Cartridge: http://www.spritesmind.net/_GenDev/forum/viewtopic.php?t=464 * - Stripe Snoop, a Magnetic Card reader: http://www.ossguy.com/ss_usb/ diff --git a/LUFA/ManPages/LibraryApps.txt b/LUFA/ManPages/LibraryApps.txt index 5b25c89be..817596790 100644 --- a/LUFA/ManPages/LibraryApps.txt +++ b/LUFA/ManPages/LibraryApps.txt @@ -6,9 +6,11 @@ /** \page Page_LibraryApps Included Library Applications * - * 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. Within this directory the demos - * are seperated by USB mode (Device, Host, OTG) and further seperated by the use or non-use of the library USB Class drivers. + * The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory. Within this + * directory the demos are seperated by USB mode (Device, Host, OTG) and further seperated by the use or non-use of the + * library USB Class drivers (which abstract out the actual implementation of the USB classes to simplify development even + * further at the expense of a loss of flexibility). + * * With one or two exceptions (e.g. proprietary classes such as RNDIS) all the included demos will work across all OSes without * the need for special drivers. One Windows, some demos require the supplied .INF file to be used as the device driver, which * directs the OS to use its inbuilt class drivers for the device. diff --git a/LUFA/ManPages/MainPage.txt b/LUFA/ManPages/MainPage.txt index 6a5057c74..6c4d431e2 100644 --- a/LUFA/ManPages/MainPage.txt +++ b/LUFA/ManPages/MainPage.txt @@ -14,7 +14,11 @@ * 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). + * 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. diff --git a/LUFA/ManPages/ProgrammingApps.txt b/LUFA/ManPages/ProgrammingApps.txt index 1e3be715a..4302170ec 100644 --- a/LUFA/ManPages/ProgrammingApps.txt +++ b/LUFA/ManPages/ProgrammingApps.txt @@ -8,7 +8,7 @@ * * Once you have built an application, you will need a way to program in the resulting ".HEX" file (and, if your * application uses EEPROM variables with initial values, also a ".EEP" file) into your USB AVR. Normally, the - * reprogramming an AVR device must be performed using a special piece of programming hardware, through one of the + * reprogramming of an AVR device must be performed using a special piece of programming hardware, through one of the * supported AVR programming protocols - ISP, HVSP, HVPP, JTAG or dW. This can be done through a custom programmer, * a third party programmer, or an official Atmel AVR tool - for more information, see the Atmel.com website. * -- cgit v1.2.3