From 42dd2b4fc66003ca7a5b2517e4a1bb5a436ab32b Mon Sep 17 00:00:00 2001
From: Jan-Philipp Litza <janphilipp@litza.de>
Date: Sat, 1 Aug 2015 11:50:27 +0200
Subject: [PATCH] Replace version table by instructions in README.md

---
 README.md | 28 +++++++++++++++++++---------
 1 file changed, 19 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 50e4b04..e12be13 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,22 @@
-## Versionen
+## Anleitung
 
-Die folgende Tabelle ordnet Bremer Firmware-Builds die entsprechenden Commits in [gluon] zu:
+Um die Bremer Firmware zu bauen sind folgende Vorbereitungen notwendig:
+```sh
+# Dieses Repository clonen
+git clone https://github.com/FreifunkBremen/gluon-site-ffhb.git
+# In das Verzeichnis wechseln
+cd gluon-site-ffhb/
+# Gluon selbst clonen
+git submodule update --init
+```
 
- Bremer Version   | Gluon Commit
-------------------|------------------------------
- 0.3.101-testing3 | 02fb281
- 0.5~testing      | 9d1958b (tag v2014.3)
- 0.6~testing1     | 1eb0d0e (tag v2014.4)
- 2014.4+bremen0   | 1eb0d0e (tag v2014.4)
+Um eine neue Testing-Version der Bremer Firmware zu bauen sind folgende Befehle nötig:
+```sh
+# Gluon auf die gewünschte Version bringen ($tag ist z.B. v2015.1.1)
+git -C gluon checkout $tag
+# Build-Prozess anstoßen
+./build.sh testing
+```
+Das Script `build.sh` versucht die richtige Versionsnummer automatisch aus dem gewählten Gluon-Tag und der letzten veröffentlichten Testing-Version zu bestimmen, sie kann aber auch manuell eingegeben werden. Will man stattdessen eine Stable bauen, ändert man einfach nur das `testing` in der letzten Zeile zu `stable`.
 
-[gluon]: https://github.com/freifunk-gluon/gluon
+Lief der Build-Prozess erfolgreich durch, liegen in `gluon/images/` die fertigen Images inklusive eines Manifests für den Autoupdater, das schon mit dem eigenen ECDSA-Key signiert wurde falls dieser unter `~/.ecdsakey` liegt.