new data format
[web/firmware-selector-openwrt-org.git] / README.md
1 # Yet Another Firmware Selector
2
3 A simple OpenWrt firmware selector using autocompletion. Uses plain HTML/JavaScript.
4
5 ![image](misc/screenshot.png)
6
7 Checkout the [Demo](https://mwarning.github.io/yet_another_firmware_selector/)!
8
9 Run:
10
11 * Download repository and change directory to it
12 * Start webserver (e.g. `python3 -m http.server`)
13 * Go to `http://localhost:8000`
14
15 Configure with [config.js](config.js).
16
17 ## Update Database
18
19 The `data.json` is based on JSON files created by OpenWrt (master): `Global build settings ---> [*] Create JSON info files per build image`.
20
21 A [Python script](misc/collect.py) is included that can merge all these JSON files for a new `data.json` file: `./collect.py bin/ --link 'https://downloads.openwrt.org/releases/%release/targets/%target/%file' > data.json`.
22
23 ## Contributions
24
25 It would be nice to have more features. E.g.:
26
27 * more translations
28 * help text for images
29 * better CSS
30
31 ## Similar Projects
32
33 - [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.
34 - [Freifunk Hennef Firmware Downloader](https://github.com/Freifunk-Hennef/ffhef-fw-dl): Similar to the project above, but PHP based.
35 - [LibreMesh Chef](https://chef.libremesh.org/): Allows to select configurations.
36 - [GSoC Firmware Selector](https://github.com/sudhanshu16/openwrt-firmware-selector/): Result of the GSoC
37 - [FFB Firmware Selector](https://github.com/freifunk-bielefeld/firmware-selector): Build for Freifunk Bielefeld