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