From 22e4b743916288a48cd7055652216a8b2690abb8 Mon Sep 17 00:00:00 2001 From: Jakob Odersky Date: Sun, 17 Jun 2012 17:34:15 +0200 Subject: update readme --- Makefile | 10 +++++----- README.md | 18 +++++++++++++++--- 2 files changed, 20 insertions(+), 8 deletions(-) diff --git a/Makefile b/Makefile index 16db019..0b1f095 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,6 @@ PREFIX = /usr/local - +#run this if you want to build everything but not install user-wide or system-wide local: compile copy compile: @@ -36,15 +36,15 @@ install-permissions: install-rules uninstall-permissions: uninstall-rules groupdel k8055 -install: compile +install-product: compile cp src/*.so $(PREFIX)/lib cp src/*.h $(PREFIX)/include -uninstall: +uninstall-product: rm $(PREFIX)/lib/libk8055.so rm $(PREFIX)/include/k8055.h -install-all: install install-permissions +install: install-product install-permissions -uninstall-all: uninstall-permissions uninstall +uninstall: uninstall-permissions uninstall-product diff --git a/README.md b/README.md index 40553ab..01b6cd9 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,10 @@ This library provides access to the Velleman K8055 USB Experiment Board for oper - (doxygen for documentation generation) ## Build -Run ```make``` in the project root folder. Products are copied to `target' directory. +### Local build +Run ```make``` or ```make local``` in the project root folder. Products are copied to `target' directory. + +To remove all generated files, run ```make clean```. ### 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). @@ -24,15 +27,24 @@ If your system uses udev, you will probably have to configure it to allow access 2. Create a group named k8055. - ```groupadd k8055``` + ```groupadd -r k8055``` 3. Add to the group yourself and/or other users whom you wish to grant access to the boards. ```usermod -a -G k8055 $(USER)``` -The previously described steps may be automated by running ```make install-rules``` to install just the rules or ```make install-permissions users=""``` to also create the group and add the given list of users to it. +The previously described steps may be automated by running ```make install-rules``` to install just the rules or ```make install-permissions 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-product``` 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-product```. + +Note that the above commands only install/uninstall the library and header files, udev configuration is not performed. To perform a complete installation and udev configuration, run the command + + ```make install USERS=""``` + +Uninstallation is done by ```make uninstall```. + ## 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. -- cgit v1.2.3