add readme

1 files changed, 53 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..ab66529
--- /dev/null
+++ b/README
@@ -0,0 +1,53 @@
+# k8055 for libusb-1.0
+
+This library acts as a driver for the Velleman K8055 USB Experiment Board for operating systems supporting libusb-1.0, such as Linux. While providing a high-
+level interface for the user, the library communicates with a k8055 board through libusb.
+
+## Requirements
+-libusb-1.0 (see src/Makefile to set include path)
+-(doxygen for documentation generation)
+
+## Build
+Run ```make''' in the project root folder. Products are copied to `target' directory.
+
+## Documentation
+See the comments in the source code for documentation about usage. Note: the API isn't the same as the one provided by Velleman in their DLL but enables the same features.
+
+Run ```make doc''' to generate doxygen documentation.
+
+## Authors
+The library is written by Jakob Odersky. Nevertheless, it is based on the information provided by the following people who wrote the original version of `libk8055' (http://libk8055.sourceforge.net/):
+
+-2005 by Sven Lindberg <k8055@k8055.mine.nu>
+
+-2007 by Pjetur G. Hjaltason <pjetur@pjetur.net>
+ Commenting, general rearrangement of code, bugfixes,
+ python interface with swig and simple k8055 python class
+
+Thanks alot to you!
+
+## License
+Copyright (c) 2012 by Jakob Odersky
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+3. The name of the author may not be used to endorse or promote products
+derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.