From bdd099572bd0aa7c66df3d819b40a8845de97b77 Mon Sep 17 00:00:00 2001
From: chrono <chrono@open-resource.org>
Date: Sun, 2 Nov 2014 13:10:37 +0100
Subject: [PATCH] Added more detailed docs for installation

---
 README.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 68 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 8f8d075..31f79a6 100644
--- a/README.md
+++ b/README.md
@@ -7,20 +7,80 @@ Turns a Raspberry Pi into a universal, web enabled Reflow Oven Controller.
 
 Based on MAX 31855 Cold-Junction K-Type Thermocouple and Raspberry Pi GPIO driven Solid State Relays.
 
+## Installation
 
-Python Requirements:
+### Dependencies
 
-Gentoo:
+We've tried to keep external dependencies to a minimum to make it easily
+deployable on any flavor of open-source operating system. If you deploy it
+successfully on any other OS, please update this:
 
-  - dev-python/bottle
-  - dev-python/gevent
-  - dev-python/gevent-websocket
+#### Currently tested versions
 
+    * greenlet-0.4.2
+    * bottle-0.12.4
+    * gevent-1.0
+    * gevent-websocket-0.9.3
 
-Raspbian:
+#### Ubuntu/Raspbian
 
-sudo apt-get install python-dev libevent-dev
-sudo pip install greenlet bottle gevent gevent-websocket
+    $ sudo apt-get install python-pip python-dev libevent-dev
+    $ sudo pip install ez-setup
+    $ sudo pip install greenlet bottle gevent gevent-websocket
 
+#### Gentoo
+
+    $ emerge -av dev-libs/libevent dev-python/pip
+    $ pip install ez-setup
+    $ pip install greenlet bottle gevent gevent-websocket
+
+#### Raspberry PI deployment
+
+If you want to deploy the code on a PI for production:
+
+    * pip install RPi.GPIO
+
+This **only applies to non-Raspbian installations**, since Raspbian ships
+RPi.GPIO with the default installation.
+
+### Clone repo
+
+    $ git clone https://github.com/apollo-ng/picoReflow.git
+    $ cd picoReflow
+
+## Configuration
+
+All parameters are defined in config.py, just copy the example and review/change to your mind's content.
+
+    $ cp config.py.EXAMPLE config.py
+
+## Usage
+
+### Server Startup
+
+    $ ./picoReflowd.py
+
+### Client Access
+
+Open Browser and goto http://127.0.0.1:8080
+
+## License
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+## Support & Contact
+
+Please use the issue tracker for project related issues.
 
 More info: https://apollo.open-resource.org/mission:resources:picoreflow