README.md

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