LUFA/MainPage.txt

   1 /** \file
   2  *
   3  *  This file contains special DoxyGen information for the generation of the main page and other special
   4  *  documentation pages. It is not a project source file.
   5  */
   6
   7 /**
   8  *  \mainpage About the LUFA (Formerly MyUSB) Library
   9  *
  10  *  Lightweight USB Framework for AVRs Library, written by Dean Camera.
  11  *
  12  *  \section Sec_About About this library
  13  *
  14  *  Originally based on the AT90USBKEY from Atmel, it is an open-source, driver for the USB-enabled AVR
  15  *  microcontrollers, released under the MIT license.
  16  *
  17  *  Currently supported AVR models:
  18  *   - AT90USB1286 (USB Device Only)
  19  *   - AT90USB1287 (USB Host and Device)
  20  *   - AT90USB646 (USB Device Only)
  21  *   - AT90USB647 (USB Host and Device)
  22  *   - AT90USB82 (USB Device Only)
  23  *   - AT90USB162 (USB Device Only)
  24  *   - ATMEGA16U4 (USB Device Only)
  25  *   - ATMEGA32U4 (USB Device Only)
  26  *   - ATMEGA32U6 (USB Device Only)
  27  *
  28  *  Currently supported Atmel boards:
  29  *   - AT90USBKEY
  30  *   - STK525
  31  *   - STK526
  32  *   - RZUSBSTICK
  33  *   - ATAVRUSBRF01
  34  *   - Custom User Boards
  35  *
  36  *  The library is currently in a stable release, suitable for download and incorporation into user projects for
  37  *  both host and device modes. For information about the project progression, check out my blog.
  38  *
  39  *  LUFA is written specifically for the free AVR-GCC compiler, and uses several GCC-only extensions to make the
  40  *  library API more streamlined and robust. You can download AVR-GCC for free in a convenient windows package,
  41  *  from the the WinAVR website.
  42  *
  43  *
  44  *  \section Sec_Links Library Links
  45  *  Project Homepage: http://www.fourwalledcubicle.com/LUFA.php \n
  46  *  Development Blog: http://www.fourwalledcubicle.com/blog \n
  47  *  Discussion Group: http://groups.google.com/group/myusb-support-list \n
  48  *  SVN Access, Bug Reports and Feature Requests: http://code.google.com/p/lufa-lib/ \n
  49  *  Author's Website: http://www.fourwalledcubicle.com \n
  50  *
  51  *  WinAVR Website: http://winavr.sourceforge.net \n
  52  *  avr-libc Website: http://www.nongnu.org/avr-libc/ \n
  53  *
  54  *  USB-IF Website: http://www.usb.org \n
  55  *
  56  *
  57  *  \section Sec_License License
  58  *  The LUFA library is currently released under the MIT licence, included below.
  59  *
  60  *  Commercial entities can opt out of the public disclosure clause in this license
  61  *  for a one-time US$1500 payment. This provides a non-exclusive modified MIT licensed which
  62  *  allows for the free use of the LUFA library, bootloaders and (where the sole copyright
  63  *  is attributed to Dean Camera) demos without public disclosure within an organisation. Please
  64  *  contact the author for more information.
  65  *
  66  *  \verbatim
  67  *  Permission to use, copy, modify, and distribute this software
  68  *  and its documentation for any purpose and without fee is hereby
  69  *  granted, provided that the above copyright notice appear in all
  70  *  copies and that both that the copyright notice and this
  71  *  permission notice and warranty disclaimer appear in supporting
  72  *  documentation, and that the name of the author not be used in
  73  *  advertising or publicity pertaining to distribution of the
  74  *  software without specific, written prior permission.
  75  *
  76  *  The author disclaim all warranties with regard to this
  77  *  software, including all implied warranties of merchantability
  78  *  and fitness.  In no event shall the author be liable for any
  79  *  special, indirect or consequential damages or any damages
  80  *  whatsoever resulting from loss of use, data or profits, whether
  81  *  in an action of contract, negligence or other tortious action,
  82  *  arising out of or in connection with the use or performance of
  83  *  this software.
  84  *  \endverbatim
  85  *
  86  *
  87  *  \section Sec_Demos Demos and Bootloaders
  88  *  The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory.
  89  *  If this directory is missing, please re-download the project from the project homepage.
  90  *
  91  *  Also included with the library are three fully functional bootloaders, located in the /Bootloaders/ subdirectory.
  92  *  The DFU class bootloader is compatible with Atmel's FLIP software or the open source dfu-programmer project, the
  93  *  CDC class (AVR109 protocol) is compatible with such open source software as AVRDUDE and AVR-OSP, and the TeensyLoader
  94  *  HID class bootloader is compatible with the software from PJRC (http://www.pjrc.com/teensy/index.html).
  95  *
  96  *
  97  *  \section Sec_Donations Donate
  98  *  I am a 20 year old University student studying for a double degree in Computer Science and Electronics Engineering.
  99  *  The development and support of this library requires much effort from myself. Please consider donating a small amount
 100  *  to myself to support this and my future Open Source projects. You can donate any amount via PayPal on my website,
 101  *  http://www.fourwalledcubicle.com . All donations are greatly appreciated.
 102  */
 103