aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGuido Günther <agx@sigxcpu.org>2016-01-28 22:00:00 +0100
committerGuido Günther <agx@sigxcpu.org>2016-01-29 18:22:13 +0100
commita394808c328d2b8ed66db30974585c8d59b3e1ee (patch)
tree8cda2aa7cb84097be73fa9285c4959718138aabd /README.md
Initial commitHEADmaster
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b63d967
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+GPIOerl
+=======
+
+Simple pure erlang module to read and write GPIO connected devices. This
+modules allow to read and write GPIO pins via the gpio module and to read
+1wire temperature sensors via the w1term module.
+
+Both were tested on the RPI.
+Run
+
+ make docs
+
+to build the documentation.
+
+To use the 1wire functionality you need to have these kernel modules loaded:
+
+ w1-gpio
+ w1-therm
+