[v2,1/7] Remove outdated commands from README

Submitted by ffml@duering-andreas.de on Jan. 26, 2019, 6:30 p.m.

Details

Message ID 20190126183032.25786-2-ffml@duering-andreas.de
State Accepted
Headers show

Commit Message

ffml@duering-andreas.de Jan. 26, 2019, 6:30 p.m.
From: Andreas Düring <gh@duering-andreas.de>

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>
---
v2: Grammatikverbesserungen, "Im Anschluss" durch etwas
ausformulierteres ersetzt. Erwähnung des Community-Files
im Abschnitt "Verwendung des Buildscripts" entfernt.
---
 README.md | 23 +++++++++++------------
 1 file changed, 11 insertions(+), 12 deletions(-)

Patch hide | download patch | download mbox

diff --git a/README.md b/README.md
index 180f2a6..781090c 100644
--- a/README.md
+++ b/README.md
@@ -13,11 +13,10 @@  Freifunk ist eine nicht-kommerzielle Initiative für freie Funknetzwerke. Jeder
 * `cd firmware`
 
 ### 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:
-* `./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?
 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.
 
-## Der Verwendung des Buildscripts
-Das BSP file 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.
+## Die Verwendung des Buildscripts
+Die BSP-Datei wird durch das Buildscript automatisch als dot-Script geladen, somit stehen dort alle Funktionen zur Verfügung.
+Das Buildscript generiert ein dynamisches sed-Script. Dies geschieht, damit die Templates mit den richtigen Werten gefüllt werden können.
 
 ### `./buildscript prepare`
 * 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
   * board_postbuild() wird aufgerufen
 
-### `./buildscript config`
-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.
+### `./buildscript config openwrt`
+Um das Arbeiten mit den .config-Datien 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
-* OpenWrt: `make menuconfig ; make kernel_menuconfig`
+* OpenWrt: `make menuconfig`
 * Speichern, y/n?
 * Config-Format vereinfachen
 * Config ins BSP zurück speichern
@@ -82,7 +82,7 @@  git clone https://github.com/FreifunkFranken/firmware.git
 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:
 ```
 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:
 ```
 ./buildscript selectbsp bsp/board_wr1043nd.bsp
-./buildscript selectcommunity community/franken.cfg
 
 ./buildscript prepare
 ./buildscript build

Comments

Adrian Schmutzler Jan. 26, 2019, 6:46 p.m.
Hallo,

Reviewed-by: Adrian Schmutzler <freifunk@adrianschmutzler.de>

Einen Tippfehler haben ich trotzdem noch gefunden. Siehe unten. Würde ich beim Applien selbst ändern.

Vielen Dank und Grüße

Adrian

> -----Original Message-----
> From: franken-dev [mailto:franken-dev-bounces@freifunk.net] On Behalf
> Of Andreas Düring
> Sent: Samstag, 26. Januar 2019 19:30
> To: franken-dev@freifunk.net
> Subject: [PATCH v2 1/7] Remove outdated commands from README
> 
> From: Andreas Düring <gh@duering-andreas.de>
> 
> 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>
> ---
> v2: Grammatikverbesserungen, "Im Anschluss" durch etwas
> ausformulierteres ersetzt. Erwähnung des Community-Files im Abschnitt
> "Verwendung des Buildscripts" entfernt.
> ---
>  README.md | 23 +++++++++++------------
>  1 file changed, 11 insertions(+), 12 deletions(-)
> 
> diff --git a/README.md b/README.md
> index 180f2a6..781090c 100644
> --- a/README.md
> +++ b/README.md
> @@ -13,11 +13,10 @@ Freifunk ist eine nicht-kommerzielle Initiative für freie
> Funknetzwerke. Jeder
>  * `cd firmware`
> 
>  ### 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:
> -* `./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?
>  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.
> 
> -## Der Verwendung des Buildscripts
> -Das BSP file 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.
> +## Die Verwendung des Buildscripts
> +Die BSP-Datei wird durch das Buildscript automatisch als dot-Script geladen,
> somit stehen dort alle Funktionen zur Verfügung.
> +Das Buildscript generiert ein dynamisches sed-Script. Dies geschieht, damit
> die Templates mit den richtigen Werten gefüllt werden können.
> 
>  ### `./buildscript prepare`
>  * 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
>    * board_postbuild() wird aufgerufen
> 
> -### `./buildscript config`
> -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.
> +### `./buildscript config openwrt`
> +Um das Arbeiten mit den .config-Datien von OpenWrt zu vereinfachen,

"Datien" -> "Dateien"

> 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
> -* OpenWrt: `make menuconfig ; make kernel_menuconfig`
> +* OpenWrt: `make menuconfig`
>  * Speichern, y/n?
>  * Config-Format vereinfachen
>  * Config ins BSP zurück speichern
> @@ -82,7 +82,7 @@ git clone
> https://github.com/FreifunkFranken/firmware.git
>  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:
>  ```
>  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:
>  ```
>  ./buildscript selectbsp bsp/board_wr1043nd.bsp -./buildscript
> selectcommunity community/franken.cfg
> 
>  ./buildscript prepare
>  ./buildscript build
> --
> 2.11.0