diff options
author | Jakob Odersky <jodersky@gmail.com> | 2012-03-31 02:33:09 +0200 |
---|---|---|
committer | Jakob Odersky <jodersky@gmail.com> | 2012-03-31 02:33:09 +0200 |
commit | 3148eda281da4c0dbb246329c555dc873dc8aad4 (patch) | |
tree | bf358450cd275cd76bb00c0cabf35da186b41d8c | |
parent | 02f5687b638b0bbb8240d32c2174aeecc5d090f9 (diff) | |
download | k8055-3148eda281da4c0dbb246329c555dc873dc8aad4.tar.gz k8055-3148eda281da4c0dbb246329c555dc873dc8aad4.tar.bz2 k8055-3148eda281da4c0dbb246329c555dc873dc8aad4.zip |
add udev rules to readme
-rw-r--r-- | Makefile | 15 | ||||
-rw-r--r-- | README.md | 15 |
2 files changed, 28 insertions, 2 deletions
@@ -17,5 +17,18 @@ mkdirs: mkdir -p target/lib mkdir -p target/include -doc: +doc: mkdirs doxygen Doxyfile + +#these commands must be run as root +install-rules: + cp k8055.rules /etc/udev/rules.d/k8055.rules +uninstall-rules: + rm /etc/udev/rules.d/k8055.rules +install-permissions: install-rules + groupadd k8055 + usermod -a -G k8055 $(USER) +uninstall-permissions: uninstall-rules + groupdel k8055 + + @@ -15,13 +15,26 @@ level interface for the user, the library communicates with a k8055 board throug ## Build Run ```make``` in the project root folder. Products are copied to `target' directory. +### 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). +1. Copy the file `k8055.rules' into the udev rules directory, typically /etc/udev/rules.d + ```cp k8055.rules /etc/udev/rules.d/k8055.rules``` +2. Create a group named k8055. + ```groupadd 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``` to also create the group and add the current user to it. +To uninstall, run ```make uninstall-rules``` or ```make uninstall-permissions```. + + ## 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. 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> |