liminix-fork/README.md

27 lines
864 B
Markdown
Raw Normal View History

2022-09-20 16:46:42 +02:00
# Liminix
2023-02-16 23:06:50 +01:00
A Nix-based system for configuring consumer wifi routers or IoT device
devices, of the kind that OpenWrt or DD-WRT or Gargoyle or Tomato run
on. It's a reboot/restart/rewrite of NixWRT.
2022-09-20 16:46:42 +02:00
This is not NixOS-on-your-router: it's aimed at devices that are
underpowered for the full NixOS experience. It uses busybox tools,
musl instead of GNU libc, and s6-rc instead of systemd.
The Liminix name comes from Liminis, in Latin the genitive declension
of "limen", or "of the threshold". Your router stands at the threshold
of your (online) home and everything you send to/receive from the
outside word goes across it.
2023-02-16 23:06:50 +01:00
## What about NixWRT?
2022-09-25 22:21:27 +02:00
This is an in-progress rewrite of NixWRT, incorporating Lessons
2023-02-16 23:06:50 +01:00
Learned.
2022-09-20 19:24:27 +02:00
2023-02-16 23:06:50 +01:00
## Documentation
2022-09-25 12:54:31 +02:00
2023-02-16 23:06:50 +01:00
Documentation is in the [doc](doc/) directory. You can build it
by running
2022-10-03 00:04:15 +02:00
2023-02-16 23:06:50 +01:00
nix-shell -p sphinx --run "make -C doc html"