README.md (1860B)
1 # Liminix 2 3 A Nix-based system for configuring consumer wifi routers or IoT device 4 devices, of the kind that OpenWrt or DD-WRT or Gargoyle or Tomato run 5 on. It's a reboot/restart/rewrite of NixWRT. 6 7 This is not NixOS-on-your-router: it's aimed at devices that are 8 underpowered for the full NixOS experience. It uses busybox tools, 9 musl instead of GNU libc, and s6-rc instead of systemd. 10 11 The Liminix name comes from Liminis, in Latin the genitive declension 12 of "limen", or "of the threshold". Your router stands at the threshold 13 of your (online) home and everything you send to/receive from the 14 outside word goes across it. 15 16 17 ## Current status (does it work yet?) 18 19 Liminix is pre-1.0. We are still finding new and better ways to do things, 20 and there is no attempt to maintain backward compatibility with the old 21 ways. 22 23 The [NEWS](NEWS) file (available wherever you found this README) is 24 a high-level overview of breaking changes. 25 26 Development mostly happens on the `main` branch, which is therefore 27 not guaranteed to build or to work on every commit. For the latest 28 functioning version, see [the CI system](https://build.liminix.org/jobset/liminix/build) and pick a revision with all jobs green. 29 30 31 ## Documentation 32 33 Documentation is in the [doc](doc/) directory. You can build it 34 by running 35 36 nix-shell -p sphinx --run "make -C doc hardware.rst html" 37 38 Rendered documentation corresponding to the latest commit on `main` 39 is published to [https://www.liminix.org/doc/](https://www.liminix.org/doc/) 40 41 42 ## Extremely online 43 44 There is a #liminix IRC channel on the [OFTC](https://www.oftc.net/) 45 network in which you are welcome. You can also connect with a Matrix 46 client by joining the room `#_oftc_#liminix:matrix.org`. 47 48 In the IRC channel, as in all Liminix project venues, please conduct yourself 49 according to the Liminix [Code of Conduct](CODE-OF-CONDUCT.md).