README.md (2236B)
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. This will change when it settles down. 22 23 _In general:_ development mostly happens on the `main` branch, which is 24 therefore not guaranteed to build or to work on every commit. For the 25 latest functioning version, see [the CI system](https://build.liminix.org/jobset/liminix/build) and pick a revision with all jobs green. 26 27 _In particular:_ as of July 2023, a significant re-arrangement of 28 modules and services is ongoing: 29 30 * if you are using out-of-tree configurations created before commit 31 2e50368, especially if they reference things under pkgs.liminix, 32 they will need updating. Look at changes to examples/rotuer.nix 33 for guidance 34 35 * the same is intermittently true for examples/{extensino,arhcive}.nix 36 where I've updated rotuer and not updated them to match. 37 38 39 ## Documentation 40 41 Documentation is in the [doc](doc/) directory. You can build it 42 by running 43 44 nix-shell -p sphinx --run "make -C doc html" 45 46 Rendered documentation corresponding to the latest commit on `main` 47 is published to [https://www.liminix.org/doc/](https://www.liminix.org/doc/) 48 49 50 ## Extremely online 51 52 There is a #liminix IRC channel on the [OFTC](https://www.oftc.net/) 53 network in which you are welcome. You can also connect with a Matrix 54 client by joining the room `#_oftc_#liminix:matrix.org`. 55 56 In the IRC channel, as in all Liminix project venues, please conduct yourself 57 according to the Liminix [Code of Conduct](CODE-OF-CONDUCT.md).