Helge Jung преди 9 години
родител
ревизия
5cd5bf5552
променени са 1 файла, в които са добавени 26 реда и са изтрити 0 реда
  1. 26 0
      ReadMe.md

+ 26 - 0
ReadMe.md

@@ -3,3 +3,29 @@
 * Basis: [Gluon](https://github.com/freifunk-gluon/gluon)
 * Site-Repository: [FFPB](https://git.c3pb.de/freifunk-pb/site-ffpb)
 
+## Vorbereitung / Umgebung
+
+Die Firmware wird auf Debian/Ubuntu gebaut. Als Requirements sind üblicherweise nur die allgemeinen Build-Tools nötig:
+
+```
+sudo apt-get install build-essential
+```
+
+## Bauen
+
+Rufe `build.sh` auf und übergebe folgende Umgebungsvariablen:
+
+* **BASE** gibt die Gluon-Version an, als Basis benutzt werden soll (z.B. 'v2014.4')
+* **BRANCH** ist der Name des Firmware-Branches (also /stable/, /testing/ oder /experimental/)
+* **VERSION** wird die Versions-Nr. der neuen Firmware (kann bei BRANCH=experimental) weggelassen werden
+
+```bash
+# Baut eine testing-Firmware auf Basis von Gluon 2014.4
+BASE=v2014.4 BRANCH=testing VERSION=0.6~rc1 ./build.sh
+
+# Baut eine experimental-Firmware auf Basis des aktuellen Gluon-Master (nur für Experten)
+BASE=master BRANCH=experimental ./build.sh
+```
+
+Nach erfolgreichem Build-Vorgang liegt die Firmware fertig paketiert im `output/` Verzeichnis und in `versions/` wurde (außer bei BRANCH=experimental) eine Versions-Informationsdatei abgelegt. Mit dieser (nur der Name) kann `build-version.sh` die gegebene Version erneut bauen.
+