aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJakob Odersky <jodersky@gmail.com>2012-07-24 12:09:55 +0200
committerJakob Odersky <jodersky@gmail.com>2012-07-24 12:09:55 +0200
commit3926f947a3a4b61108248b336381b6b3f78b489b (patch)
tree28ed08d7b13c9bcc87a4efccc3c7892f85e9f412
parent216cd2817359e1f75d22049b973be8aa7d32456b (diff)
downloadk8055-3926f947a3a4b61108248b336381b6b3f78b489b.tar.gz
k8055-3926f947a3a4b61108248b336381b6b3f78b489b.tar.bz2
k8055-3926f947a3a4b61108248b336381b6b3f78b489b.zip
reformat & correct readme
-rw-r--r--README.md17
1 files changed, 7 insertions, 10 deletions
diff --git a/README.md b/README.md
index c961fd5..ce672cf 100644
--- a/README.md
+++ b/README.md
@@ -5,11 +5,11 @@ This library provides access to the Velleman K8055 USB Experiment Board for oper
## Main Features
- runs with libusb-1.0
- up to 4 k8055 boards supported simultaneously (limit is given by k8055 hardware)
-- pseudo-querying of a board's ouput status (see header file documentation for detailed explanation)
-- lightweight (one source file, one header file => one shared library)
+- pseudo-querying of a board's output status (see header file documentation for detailed explanation)
+- concise and lightweight
## Requirements
-- libusb-1.0 (see src/Makefile to set include path)
+- libusb-1.0
- (doxygen for documentation generation)
## Build
@@ -18,8 +18,11 @@ Run ```make local``` in the project root folder. Products are copied to 'target'
To remove all generated files, run ```make clean```.
+### System install
+Run ```make install``` to install the library and header files (this command does essentially the same as a local build with the exception that products are copied to /usr/local/ by default). You may change that path by passing 'make' the variable 'PREFIX', i.e. ```make install PREFIX=/my/custom/path```. To uninstall, run ```make uninstall```.
+
### Udev Rules
-If your system uses udev, you will probably have to configure it to allow access the k8055 boards. The following instructions show how to configure udev (you will need root privileges).
+If your system uses udev, you will probably have to configure it to allow access to the k8055 boards. The following instructions show how to configure udev (you will need root privileges).
1. Copy the file `k8055.rules' into the udev rules directory, typically /etc/udev/rules.d
@@ -36,12 +39,6 @@ If your system uses udev, you will probably have to configure it to allow access
The previously described steps may be automated by running ```make install-rules``` to install just the rules or ```make install-permissions USERS="<list of users>"``` to also create the group and add the given list of users to it.
To uninstall, run ```make uninstall-rules``` or ```make uninstall-permissions```.
-### System install
-Run ```make install``` to install the library and header files (this command does essentially the same as a local build with the exception that products are copied to /usr/local/ by default). You may change that path by passing 'make' the variable 'PREFIX', i.e. ```make install PREFIX=/my/custom/path```. To uninstall, run ```make uninstall```.
-
-Note that the above commands only install/uninstall the library and header files, udev configuration is not performed.
-
-
## 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.