mote that modules are in a state of flux

This commit is contained in:
Daniel Barlow 2023-07-16 17:39:01 +01:00
parent f73a9d82dc
commit 17abd42cf3

View file

@ -13,10 +13,29 @@ of "limen", or "of the threshold". Your router stands at the threshold
of your (online) home and everything you send to/receive from the of your (online) home and everything you send to/receive from the
outside word goes across it. outside word goes across it.
## What about NixWRT?
This is an in-progress rewrite of NixWRT, incorporating Lessons ## Current status (does it work yet?)
Learned.
Liminix is pre-1.0. We are still finding new and better ways to do things,
and there is no attempt to maintain backward compatibility with the old
ways. This will change when it settles down.
In general: development mostly happens on the `main` branch, which is
therefore not guaranteed to build or to work on every commit. For the
latest functioning version, see [the CI system](https://build.liminix.org/jobset/liminix/build) and pick a
revision with all jobs green.
In particular, as of July 2023, a significant re-arrangement of
modules and services is ongoing:
* if you are using out-of-tree configurations created before commit
2e50368, especially if they reference things under pkgs.liminix,
they will need updating. Look at changes to examples/rotuer.nix
for guidance
* the same is intermittently true for examples/{extensino,arhcive}.nix
where I've updated rotuer and not updated them to match.
## Documentation ## Documentation
@ -25,6 +44,9 @@ by running
nix-shell -p sphinx --run "make -C doc html" nix-shell -p sphinx --run "make -C doc html"
Rendered documentation corresponding to the latest commit on `main`
is published to [https://www.liminix.org/doc/](https://www.liminix.org/doc/)
## Extremely online ## Extremely online