From b220cd4ad0306552b8fd02573d9b91da807aa90b Mon Sep 17 00:00:00 2001
From: Christian Starkjohann <cs+github@obdev.at>
Date: Thu, 6 Dec 2012 00:33:29 +0100
Subject: Added README.md for github.

---
 README.md                       | 33 +++++++++++++++++++++++++++++++++
 mkdist.sh                       |  2 +-
 v-usb.xcodeproj/project.pbxproj |  2 ++
 3 files changed, 36 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..88b29da
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+What is V-USB?
+==============
+V-USB is a firmware-only USB driver for Atmel's AVR microcontrollers.
+For more information please visit <http://www.obdev.at/vusb/>.
+
+What is in this Repository?
+===========================
+This repository contains the source code of the driver (in the usbdrv
+subdirectory), examples (in the examples) subdirectory and other things
+you might need when you design a device using V-USB.
+
+When you check out this repository, the resulting directory is *not* equivalent
+to the source code package which can be downloaded at
+<http://www.obdev.at/vusb/>. Some files in the source code package are generated
+by scripts when the package is created. On the other hand, the scripts which
+generate source files and the package are not contained in the package itself.
+
+If you want to know more about the files and directories, see the file
+Readme.txt in the top level directory.
+
+How do I Add the Driver to My Project?
+======================================
+Simply copy the entire usbdrv subdirectory into your project's firmware
+source code directory. Then edit the firmware's Makefile and add the following
+object files to your binary:
+
+    usbdrv/usbdrv.o
+    usbdrv/usbdrvasm.o
+    usbdrv/oddebug.o
+
+Then make sure that your Makefile contains rules to convert *.S and *.c to
+object files. See the Makefiles in the examples subdirectory for an
+inspiration.
diff --git a/mkdist.sh b/mkdist.sh
index 1556cab..05e6efb 100755
--- a/mkdist.sh
+++ b/mkdist.sh
@@ -132,7 +132,7 @@ make files
 
 rm -rf examples/drivertest v-usb.xcodeproj
 find . -name 'make-files.sh' -exec rm '{}' \;   # remove helper scripts
-rm -f mkdist.sh .gitignore
+rm -f mkdist.sh README.md .gitignore
 (
     cd usbdrv
     cp Changelog.txt License.txt CommercialLicense.txt USB-IDs-for-free.txt USB-ID-FAQ.txt ..
diff --git a/v-usb.xcodeproj/project.pbxproj b/v-usb.xcodeproj/project.pbxproj
index e4fc3d9..9d24d4b 100644
--- a/v-usb.xcodeproj/project.pbxproj
+++ b/v-usb.xcodeproj/project.pbxproj
@@ -79,6 +79,7 @@
 		40D64A840EAA502A00FF5D92 /* osccal.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = osccal.h; sourceTree = "<group>"; };
 		40D64B590EAA740400FF5D92 /* usbdrv */ = {isa = PBXFileReference; lastKnownFileType = folder; path = usbdrv; sourceTree = "<group>"; };
 		40EB7F8E166F73E60099159E /* Makefile */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.make; path = Makefile; sourceTree = "<group>"; usesTabs = 1; };
+		40EB7F9D16700CA20099159E /* README.md */ = {isa = PBXFileReference; lastKnownFileType = text; path = README.md; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXGroup section */
@@ -98,6 +99,7 @@
 		40D2CC570DA921F000DC4278 = {
 			isa = PBXGroup;
 			children = (
+				40EB7F9D16700CA20099159E /* README.md */,
 				40EB7F8E166F73E60099159E /* Makefile */,
 				40D2CC6D0DA9221D00DC4278 /* Readme.txt */,
 				40D2CC6C0DA9221D00DC4278 /* mkdist.sh */,
-- 
cgit v1.2.3