From f4f619e52e097341ec2869269a18110ccd28467c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Steffen=20M=C3=B6ller?= <steffen_moeller@gmx.de>
Date: Sat, 21 Jun 2014 20:04:14 +0200
Subject: [PATCH 1/3] Basic install instructions

---
 README.md | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index de0e1c5..f4c38d4 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,39 @@
-See mkmap.sh for now :)
+ffmap-backend - Data for Freifunk Map
+
+ffmap-backend gathers information on the batman network by invoking 
+   batctl
+and
+   batadv-vis
+as root (via sudo) and has this information placed into a target directory
+as the file "nodes.json" and also updates the directory "nodes" with graphical
+representations of uptimes and the number of clients connecting.
+
+The target directory is suggested to host all information for interpreting those
+node descriptions, e.g. as provided by https://github.com/ffnord/ffmap-d3.git .
+When executed without root privileges, we suggest to grant sudo permissions
+within wrappers of those binaries, so no further changes are required in other
+scripts:
+
+$ cat <<EOCAT > $HOME/batctl
+#!/bin/sh
+exec sudo /usr/sbin/batctl $*
+EOCAT
+
+and analogously for batadv-vis. The entry for /etc/sudoers could be
+whateveruser   ALL=(ALL:ALL) NOPASSWD: /usr/sbin/batctl,/usr/sbin/batadv-vis,/usr/sbin/alfred-json
+
+The destination directory can be made directly available through apache:
+
+$ cat /etc/apache2/site-enabled/000-default
+...
+        <Directory /home/whateverusername/www/>
+                Options Indexes FollowSymLinks MultiViews
+                AllowOverride None
+                Order allow,deny
+                allow from all
+        </Directory>
+...
+
+$ cat /etc/apache2/conf.d/freifunk
+Alias /map /home/ffmap/www/
+Alias /firmware /home/freifunk/autoupdates/

From 6664c0d53e905c10bd156d23e151ea1889c7f55d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Steffen=20M=C3=B6ller?= <steffen_moeller@gmx.de>
Date: Sat, 21 Jun 2014 20:16:52 +0200
Subject: [PATCH 2/3] Explained execution of mkmap.sh and crontab

Also improved markdown formatting ... slightly.
---
 README.md | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f4c38d4..febbc42 100644
--- a/README.md
+++ b/README.md
@@ -14,16 +14,18 @@ When executed without root privileges, we suggest to grant sudo permissions
 within wrappers of those binaries, so no further changes are required in other
 scripts:
 
+<pre>
 $ cat <<EOCAT > $HOME/batctl
 #!/bin/sh
 exec sudo /usr/sbin/batctl $*
 EOCAT
+</pre>
 
 and analogously for batadv-vis. The entry for /etc/sudoers could be
 whateveruser   ALL=(ALL:ALL) NOPASSWD: /usr/sbin/batctl,/usr/sbin/batadv-vis,/usr/sbin/alfred-json
 
 The destination directory can be made directly available through apache:
-
+<pre>
 $ cat /etc/apache2/site-enabled/000-default
 ...
         <Directory /home/whateverusername/www/>
@@ -37,3 +39,13 @@ $ cat /etc/apache2/site-enabled/000-default
 $ cat /etc/apache2/conf.d/freifunk
 Alias /map /home/ffmap/www/
 Alias /firmware /home/freifunk/autoupdates/
+</pre>
+
+To execute, run 
+ ./mkmap.sh ../www
+The script expects above described sudo-wrappers in the $HOME directory of the user executing
+the script. If those are not available, an error will occurr if not executed as root. Also,
+the tool realpath optionally allows to execute the script from anywhere in the directory tree.
+
+For the script's regular execution add the following to the crontab:
+*/5 * * * * /home/ffmap/ffmap-backend/mkmap.sh /home/ffmap/www

From a53715b554f485e8bd9c9181fed4ce5e9ab837a0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Steffen=20M=C3=B6ller?= <steffen_moeller@gmx.de>
Date: Sat, 21 Jun 2014 20:18:41 +0200
Subject: [PATCH 3/3] Syntax

---
 README.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index febbc42..fc718fe 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-ffmap-backend - Data for Freifunk Map
+# Data for Freifunk Map, Graph and Node List
 
 ffmap-backend gathers information on the batman network by invoking 
    batctl
@@ -48,4 +48,6 @@ the script. If those are not available, an error will occurr if not executed as
 the tool realpath optionally allows to execute the script from anywhere in the directory tree.
 
 For the script's regular execution add the following to the crontab:
+<pre>
 */5 * * * * /home/ffmap/ffmap-backend/mkmap.sh /home/ffmap/www
+</pre>