From 4e9cbe3e4e9ab07f397291baa2c24b1935def18c Mon Sep 17 00:00:00 2001 From: Tom Herbers Date: Sun, 15 Aug 2021 00:35:54 +0200 Subject: [PATCH] README.md: more infos --- README.md | 49 ++++++++++++++++++++++++++++++++++++------------- 1 file changed, 36 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 5ddb818..098a2f4 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,47 @@ # Freifunk Rhein Neckar - Gluon site -This is the site configuration of the [FFRN](https://www.freifunk-rhein-neckar.de/) for our on [Gluon](https://github.com/freifunk-gluon/gluon) based Firmware. +This is the site configuration of the [FFRN](https://www.freifunk-rhein-neckar.de/) for our [Gluon](https://github.com/freifunk-gluon/gluon) based Firmware. +## Firmware -## Official Firmware of FFRN (recommended) +### Official Firmware of FFRN (recommended) Our official Firmware images (build with this site configuration) can be found under [fw.ffrn.de](https://fw.ffrn.de). It is recommended to use those firmware releases! -## Build your own Firmware -If you want to build your own gluon images you could [start here](https://gluon.readthedocs.io/en/latest/user/getting_started.html#building-the-images). But keep in mind to no not disturb our network and update your router continuously. +### Building it yourself +You are welcome to build your own firmware for your nodes. A good starting point are the [docs of Gluon](https://gluon.readthedocs.io/en/latest/user/getting_started.html#building-the-images). +However, please try not to disturb our network. We also don't particularly like it when devices don't get regular updates. +If you have any questions, please feel welcome to contact the community: [Kontakt - Freifunk Rhein-Neckar](https://www.freifunk-rhein-neckar.de/kontakt/) -## Changes we make to gluon -Our firmware images are generally based on the releases of [Gluon](https://github.com/freifunk-gluon/gluon). +--- -The only change we currently make is, that we use for the status page and the config mode, instead of magenta (`#dc0067`), a green (`#52995d`). This should only be done for our official releases to ensure a quick hint if a node uses our official firmware. If you build your own gluon please don't change the color (or you could use something different then green). But please keep the green for us. +## Branches -To change the color you have to replace the value of `$ffmagenta` in `package/gluon-config-mode-theme/sass/gluon.scss` and inside the `header` section of `package/gluon-status-page/sass/status-page.scss` the value of the `background` color. -After you have done that you have to compile those scss files by running the following two sass commands: -``` -sass --sourcemap=none -C -t compressed package/gluon-config-mode-theme/sass/gluon.scss package/gluon-config-mode-theme/files/lib/gluon/config-mode/www/static/gluon.css -sass --sourcemap=none -C -t compressed package/gluon-status-page/sass/status-page.scss package/gluon-status-page/files/lib/gluon/status-page/www/static/status-page.css -``` \ No newline at end of file + +* `master`: + * matches Gluons `master` branch +* `multidomain`: + * matches our `master` but with additional multidomain support + * currently published as nightly + * firmware version: 1.6.x-yyyymmdd +* `v2021.1.x`: + * matches Gluon `v2021.1.x` branch + * firmware version: v1.6.x +* `v2020.2.x`: + * matches Gluon `v2020.2.x` branch + * firmware version: 1.5.x +* `v2019.1.x`: + * matches Gluon `v2019.1.x` branch + * firmware version: 1.3.x + + +## Releases + +| Release | Gluon Commit | +| -------- | -------- | +| 1.6.0 | [v2021.1](https://github.com/freifunk-gluon/gluon/commit/0f9a6334a04da2e3916b1e1ba037f49647fb0064) | +| 1.5.2 | [v2020.2.2](https://github.com/freifunk-gluon/gluon/commit/90d0e33c619cef9e0af928ef4d6477f6c1bdc0de) | +| 1.5.1 | [v2020.2.1](https://github.com/freifunk-gluon/gluon/commit/8547bd43406a64cc652d6d8a778064f4b9b4cdfe) | +| 1.3.1 | [v2019.1.2](https://github.com/freifunk-gluon/gluon/commit/63ebeb25c0b3a7eec4c70efc92dfcfa760dd85b6) | +| 1.2.3 | [v2018.2.3](https://github.com/freifunk-gluon/gluon/commit/e3f280584170c6e12549f1f00276f966cc168975) |