summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f410fd7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+Raspberry Pi Temperature Monitor
+================================
+
+Installation
+------------
+
+1. Add the following lines to your Pi's /etc/modules
+
+> w1-gpio
+> w1-therm
+
+2. Reboot, or run:
+
+> sudo modprobe w1-gpio
+> sudo modprobe w1-therm
+
+3. Set the correct settings in the config.yml file
+
+Running
+-------
+
+The software runs like an initscript. Once started, it daemonises and returns you to a terminal.
+
+> ruby temp.rb start
+> ruby temp.rb restart
+> ruby temp.rb stop