diff --git a/README.md b/README.md index 8466d1509d785bcd9c411058ee38fbd6ff14c294..58ab4cfd8a3ddc1e909e97db05c08a8dd33c31d0 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,40 @@ -site-ffs -======== - -Freifunk Stuttgart specific Gluon configuration - - -Doku: https://gluon.readthedocs.org/en/latest/user/site.html - -Gluon versions used for specific Stuttgart Freifunk Firmware builds: -* ffs-1.7: v2018.2.3-ffs0.1 -* ffs-1.6: v2018.2.2-ffs0.1 -* ffs-1.4: v2017.1.5 (LEDE) -* ffs-1.3: v2016.2.7 + 1340 mtu -* ffs-1.2: v2016.2.6 + ffs-set-segment dns fix + 1312 mtu -* ffs-1.1: v2016.2.6 + ffs-set-segment dns fix -* ffs-1.0: v2016.2.5 -* ffs-0.9: v2016.2.1 -* ffs-0.8: v2016.2 -* ffs-0.7: v2016.1.3 -* ffs-0.6: v2016.1 -* ffs-0.5: v2015.1.2 +# Freifunk Stuttgart Gluon + +This is the [Gluon configuration](https://gitlab.freifunk-stuttgart.de/firmware/site-ffs) for [Freifunk Stuttgart](https://freifunk-stuttgart.de). + +Firmware versions are built in Gitlab. + +We maintain our [own Gluon repository](https://gitlab.freifunk-stuttgart.de/firmware/gluon) to make it easy to apply patches to Gluon. + +Gluon is maintained as a [Git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) in the `gluon` subdirectory. + +## Building + +Because we maintain Gluon as a submodule, some special steps are required: + +- clone this repository with `--recurse-submodules`: ```git clone --recurse-submodules https://gitlab.freifunk-stuttgart.de/firmware/site-ffs.git``` + * If you already clonsed this repo, initalize submodules using `git submodule update --init .` +- run `buildall.sh` to build all targets + +### Download Cache + +We maintain a [cache of all downloaded files during the build](https://gitlab.freifunk-stuttgart.de/firmware/ffs-openwrt-dl-cache). + +## Committing + +When changing something in Gluon, keep in mind - besides making the changes in the Gluon repository - you also need to make a commit here that updates the `gluon` submodule. You can do so by: +- changing to the `gluon` subdirectory, +- making your changes, +- commit and push them to the Gluon repository, +- going back to the `site-ffs` directory, +- `git add gluon` and then `git commit` to create a commit which updates the Gluon version in the site-ffs repo. + +## Automatic Gluon Update + +Minor version updates of Gluon are usually very easy to do. Therefore, we have a daily job which checks for a new minor version of Gluon and performs an [automatic update](https://gitlab.freifunk-stuttgart.de/firmware/ffs-pipeline-nightly) if one is available. + +## Other repositories + +We have a [repository with our custom packages](https://gitlab.freifunk-stuttgart.de/firmware/gluon-packages). + +There are [several other repos related to the firmware build](https://gitlab.freifunk-stuttgart.de/firmware).