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] 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