aboutsummaryrefslogtreecommitdiffstats
path: root/Readme.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Readme.txt')
-rw-r--r--Readme.txt72
1 files changed, 72 insertions, 0 deletions
diff --git a/Readme.txt b/Readme.txt
new file mode 100644
index 0000000..6a35b51
--- /dev/null
+++ b/Readme.txt
@@ -0,0 +1,72 @@
+This is the Readme file to Objective Development's firmware-only USB driver
+for Atmel AVR microcontrollers and related code. For more information please
+visit http://www.obdev.at/avrusb/.
+
+
+WHAT IS INCLUDED IN THIS PACKAGE?
+=================================
+This package consists of the device side USB driver firmware, library code
+for device and host and fully working examples for device and host:
+
+ Readme.txt .............. The file you are currently reading.
+ License.txt ............. Free Open Source license for this package (GPL).
+ CommercialLicense.txt ... Alternative commercial license for this package.
+ usbdrv .................. AVR-USB firmware, to be included in your project.
+ circuits ................ Example circuits using this driver.
+ libs-device ............. Useful code snippets for the device firmware.
+ libs-host ............... Useful code snippets for device drivers.
+ examples ................ Example code for device and host side.
+
+Each subdirectory contains a separate Readme file which explains its
+contents.
+
+
+PREREQUISITES
+=============
+The AVR code of AVR-USB is written in C and assembler. You need either
+avr-gcc or IAR CC to compile the project. We recommend avr-gcc because it
+is free and easily available. Gcc version 3 generates slightly more
+efficient code than version 4 for AVR-USB. Not every release is tested with
+the IAR compiler. Previous versions have been tested with IAR 4.10B/W32 and
+4.12A/W32 on an ATmega8 with the "small" and "tiny" memory model.
+
+Ready made avr-gcc tool chains are available for most operating systems:
+ * Windows: WinAVR http://winavr.sourceforge.net/
+ * Mac: AVRMacPack http://www.obdev.at/avrmacpack/
+ * Linux and other Unixes: Most free Unixes have optional packages for AVR
+ development. If not, follow the instructions at
+ http://www.nongnu.org/avr-libc/user-manual/install_tools.html
+
+Our host side examples are compiled with gcc on all platforms. Gcc is the
+default C compiler on Mac, Linux and many other Unixes. On windows, we
+recommend MinGW (http://www.mingw.org/). Use the automated MinGW installer
+for least troubles. You also need MSYS from the same site to work with
+standard Makefiles.
+
+Most examples also depend on libusb. Libusb is available from
+http://libusb.sourceforge.net/ for Unix and
+http://libusb-win32.sourceforge.net/ for Windows.
+
+
+TECHNICAL DOCUMENTATION
+=======================
+The API reference of the driver firmware can be found in usbdrv/usbdrv.h.
+Documentation for host and device library files are in the respective header
+files. For more information, follow the "Documentation Wiki" link in the
+navigation box at http://www.obdev.at/avrusb/.
+
+
+LICENSE
+=======
+AVR-USB and related code is distributed under the terms of the GNU General
+Public License (GPL) version 2 (see License.txt for details). In addition to
+the terms of the GPL, we strongly encourage you to publish your entire
+project and mail OBJECTIVE DEVELOPMENT a link to your publication.
+
+Alternatively, we offer a commercial license without the restrictions of the
+GPL. See CommercialLicense.txt for details.
+
+
+----------------------------------------------------------------------------
+(c) 2008 by OBJECTIVE DEVELOPMENT Software GmbH.
+http://www.obdev.at/