path: root/README.md
diff options
Diffstat (limited to 'README.md')
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 @@
+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.
+ make docs
+to build the documentation.
+To use the 1wire functionality you need to have these kernel modules loaded:
+ w1-gpio
+ w1-therm