mark
/
firmware
forked from freifunk-franken/firmware
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

README: Remove outdated commands 

Remove mentions of "selectcommunity" command and community file.
Start removing mentions of bsp which is not available.
Fix buildscript commands (there is no kernel config).

Signed-off-by: Andreas Düring <gh@duering-andreas.de>
Reviewed-by: Adrian Schmutzler <freifunk@adrianschmutzler.de>
Reviewed-by: Robert Langhammer <rlanghammer@web.de>
This commit is contained in:
Andreas Düring 2019-01-26 19:30:26 +01:00 committed by Adrian Schmutzler
parent 9b5d3f1aeb
commit 57629e87fe
1 changed files with 11 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -13,11 +13,10 @@ Freifunk ist eine nicht-kommerzielle Initiative für freie Funknetzwerke. Jeder
* `cd firmware` * `cd firmware`
### Erste Schritte ### Erste Schritte
Mit Hilfe der Community-Files werden Parameter, wie die ESSID, der Kanal sowie z.B. die Netmon-IP gesetzt. Diese Einstellungen sind Community weit einheitlich und müssen i.d.R. nicht geändert werden.
* `./buildscript selectcommunity community/franken.cfg`
Je nach dem, für welche Hardware die Firmware gebaut werden soll muss das BSP gewählt werden: Je nach dem, für welche Hardware die Firmware gebaut werden soll muss das BSP gewählt werden:
* `./buildscript selectbsp bsp/board wr1043nd.bsp`
* `./buildscript` * `./buildscript selectbsp bsp/board_ar71xx.bsp`
* Um die vorhandenen BSPs zu sehen, kann `./buildscript selectbsp help` ausgeführt werden.
## Was ist ein BSP? ## Was ist ein BSP?
Ein BSP (Board-Support-Package) beschreibt, was zu tun ist, damit ein Firmware Image für eine spezielle Hardware gebaut werden kann. Ein BSP (Board-Support-Package) beschreibt, was zu tun ist, damit ein Firmware Image für eine spezielle Hardware gebaut werden kann.
@ -35,9 +34,9 @@ Typischerweise ist eine folgene Ordner-Struktur vorhanden:
Die Daten des BSP werden nie alleine verwendet. Zu erst werden immer die Daten aus dem "default"-BSP zum Ziel kopiert, erst danach werden die Daten des eigentlichen BSPs dazu kopiert. Durch diesen Effekt kann ein BSP die "default" Daten überschreiben. Die Daten des BSP werden nie alleine verwendet. Zu erst werden immer die Daten aus dem "default"-BSP zum Ziel kopiert, erst danach werden die Daten des eigentlichen BSPs dazu kopiert. Durch diesen Effekt kann ein BSP die "default" Daten überschreiben.
## Der Verwendung des Buildscripts ## Die Verwendung des Buildscripts
Das BSP file durch das Buildscript automatisch als dot-Script geladen, somit stehen dort alle Funktionen zur Verfügung. Die BSP-Datei wird durch das Buildscript automatisch als dot-Script geladen, somit stehen dort alle Funktionen zur Verfügung.
Das Buildscript lädt ebenfalls automatisch das Community file und generiert ein dynamisches sed-Script, dies geschieht, damit die Templates mit den richtigen Werten gefüllt werden können. Das Buildscript generiert ein dynamisches sed-Script. Dies geschieht, damit die Templates mit den richtigen Werten gefüllt werden können.
### `./buildscript prepare` ### `./buildscript prepare`
* Sourcen werden in einen separaten src-Folder geladen, sofern diese nicht schon da sind. Zu den Sourcen zählen folgende Komponenten: * Sourcen werden in einen separaten src-Folder geladen, sofern diese nicht schon da sind. Zu den Sourcen zählen folgende Komponenten:
@ -65,10 +64,11 @@ Das Buildscript lädt ebenfalls automatisch das Community file und generiert ein
* postbuild * postbuild
* board_postbuild() wird aufgerufen * board_postbuild() wird aufgerufen
### `./buildscript config` ### `./buildscript config openwrt`
Um das Arbeiten mit den OpenWrt .config's zu vereinfachen bietet das Buildscript die Möglichkeit die OpenWrt menuconfig und die OpenWrt kernel_menuconfig aufzurufen. Im Anschluss hat man die Möglichkeit die frisch editierten Configs in das BSP zu übernehmen. Um das Arbeiten mit den .config-Dateien von OpenWrt zu vereinfachen, bietet das Buildscript die Möglichkeit das `menuconfig` von OpenWrt aufzurufen. Nachdem man die gewünschten Einstellungen vorgenommen hat, hat man die Möglichkeit, die frisch editierte Konfiguration in das BSP zu übernehmen.
Dieses Kommando arbeitet folgendermaßen:
* prebuild * prebuild
* OpenWrt: `make menuconfig ; make kernel_menuconfig` * OpenWrt: `make menuconfig`
* Speichern, y/n? * Speichern, y/n?
* Config-Format vereinfachen * Config-Format vereinfachen
* Config ins BSP zurück speichern * Config ins BSP zurück speichern
@ -82,7 +82,7 @@ git clone https://github.com/FreifunkFranken/firmware.git
cd firmware cd firmware
``` ```
### Erstes Images erzeugen ### Erste Images erzeugen
Du fügst im board_postbuild ein, dass auch die Images für den wr1043v2 kopiert werden: Du fügst im board_postbuild ein, dass auch die Images für den wr1043v2 kopiert werden:
``` ```
vim bsp/board_wr1043nd.bsp vim bsp/board_wr1043nd.bsp
@ -101,7 +101,6 @@ cp bsp/wr1043nd/root_file_system/etc/network.tl-wr1043nd-v1 bsp/wr1043nd/root_fi
Anschließend kann ein erstes Image erzeugt werden: Anschließend kann ein erstes Image erzeugt werden:
``` ```
./buildscript selectbsp bsp/board_wr1043nd.bsp ./buildscript selectbsp bsp/board_wr1043nd.bsp
./buildscript selectcommunity community/franken.cfg
./buildscript prepare ./buildscript prepare
./buildscript build ./buildscript build