diff options
| author | Jakob Odersky <jodersky@gmail.com> | 2012-03-31 01:49:36 +0200 |
|---|---|---|
| committer | Jakob Odersky <jodersky@gmail.com> | 2012-03-31 01:49:36 +0200 |
| commit | f019645d4cefeec17ff8e20b83160dd59eb6d001 (patch) | |
| tree | b84b9098854a308f33b692567a6e72533dd3c159 /README.md | |
| parent | ee76d0f5cf261bbe08822fa27e960a8f7475f809 (diff) | |
| download | k8055-f019645d4cefeec17ff8e20b83160dd59eb6d001.tar.gz k8055-f019645d4cefeec17ff8e20b83160dd59eb6d001.tar.bz2 k8055-f019645d4cefeec17ff8e20b83160dd59eb6d001.zip | |
add feature description to readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 9 |
1 files changed, 7 insertions, 2 deletions
@@ -3,6 +3,11 @@ This library acts as a driver for the Velleman K8055 USB Experiment Board (http://www.velleman.eu) 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. +## Main Features +- runs with libusb-1.0 +- up to 4 k8055 boards supported simultaneously (limit is given by k8055 hardware) +- lightweight (one source file, one header file => one shared library) + ## Requirements - libusb-1.0 (see src/Makefile to set include path) - (doxygen for documentation generation) @@ -11,12 +16,12 @@ level interface for the user, the library communicates with a k8055 board throug 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. +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. 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/): +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> |