aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/README.md b/README.md
index fdea76a..730fe3d 100644
--- a/README.md
+++ b/README.md
@@ -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>