ci: remove superfluous before_script

[web/firmware-selector-openwrt-org.git] / README.md

diff --git a/README.md b/README.md
index 9a9e7dd01fa66c976752be3948e766ca4b9c92b3..7ea9464b86dd10fce0a2943407e2de3ffae4d8fc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,9 +1,58 @@
 # Yet Another Firmware Selector
 
-Still in development state. OpenWrt can now create json files that can be globbed together. No need for heuristics on firmware names anymore.
+A simple OpenWrt firmware selector using autocompletion. Uses plain
+HTML/CSS/JavaScript. Checkout the [Demo](https://mwarning.github.io/yet-another-firmware-selector/www/).
+
+![image](misc/screenshot.png)
+
+
+## Quick Run
+
+* Download the sources and change the working directory
+* Start webserver (e.g. `python3 -m http.server`)
+* Go to `http://localhost:8000/www/` in your web browser
+
+Configure with [config.js](www/config.js).
+
+## Attended Sysupgrade Support
+
+This firmware selector can speak to a [ASU server](https://github.com/aparcar/asu) to build custom images. To enable the feature, the `asu_url` option in the config.js needs to be set.
+
+## Installation
+
+Place the `www/` folder somewhere web accessible. Then use the `collect.py` script to update the `config.json` file:
+
+```
+./misc/collect.py scan "https://firmware.example.com/{version}/targets/{target}" ~/openwrt/bin/ www/
+```
+
+This should do it.
+
+The https link is used to access image files. There are different variables available:
+
+* `{version}`: Version in the profiles.json files. E.g. `19.07.4` or `SNAPSHOT`.
+* `{target}`: Main- and sub target, E.g. `ath79/generic`.
+* `{base}`: Distinct path to the targets directory. E.g. `releases/18.06.8/targets/`
+
+The `collect.py` script searches the `~/openwrt/bin/` directory for `profile.json` files. These are merged into `overview.json` files (one per release). The `overview.json` files are then placed into `www/data/` and `www/config.js` is updated.
+
+To let OpenWrt create `profile.json` files, enable the build setting (`make menuconfig`):
+`Global build settings  ---> [*] Create JSON info files per build image`.
+
+If the option is not available (OpenWrt 18.06 or 19.07.3), apply commit [openwrt/openwrt@881ed09](https://github.com/openwrt/openwrt/commit/881ed09ee6e23f6c224184bb7493253c4624fb9f).
+
+### Scrape
+
+If you want to scrape the OpenWrt download website and update the `config.js`:
 
 ```
-git clone ...
-cd yet*
-python3 -m http.server
+./misc/collect.py scrape https://downloads.openwrt.org www/
 ```
+
+## Similar Projects
+
+- [Gluon Firmware Selector](https://github.com/freifunk-darmstadt/gluon-firmware-selector): Original source of this project for images generated by [Gluon](https://github.com/freifunk-gluon/), now with pictures.
+- [Freifunk Hennef Firmware Downloader](https://github.com/Freifunk-Hennef/ffhef-fw-dl): Similar to the project above, but PHP based.
+- [LibreMesh Chef](https://github.com/libremesh/chef/): Allows to select configurations.
+- [GSoC Firmware Selector](https://github.com/sudhanshu16/openwrt-firmware-selector/): Result of the GSoC
+- [FFB Firmware Selector](https://github.com/freifunk-bielefeld/firmware-selector): Build for Freifunk Bielefeld