aboutsummaryrefslogtreecommitdiff
path: root/lib/nix-furnace/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'lib/nix-furnace/README.md')
-rw-r--r--lib/nix-furnace/README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/lib/nix-furnace/README.md b/lib/nix-furnace/README.md
new file mode 100644
index 0000000..cff5c2d
--- /dev/null
+++ b/lib/nix-furnace/README.md
@@ -0,0 +1,7 @@
+# `nix-furnace`
+my homebrewed library for defining nix machines
+
+Features:
+- Homogenous modules: each module contains a home part, a system part, and a shared `options.nix`
+- Path-based: All modules in `modules/` are imported automatically
+- Exclusive: Only supports single-user nixos machines running home-manager