From bf56200345b606e04cf49e71b97f04b36c7b4845 Mon Sep 17 00:00:00 2001
From: Colin <colin@uninsane.org>
Date: Sun, 14 May 2023 08:56:38 +0000
Subject: [PATCH] hosts: document the directory structure

---
 hosts/README.md | 7 +++++++
 1 file changed, 7 insertions(+)
 create mode 100644 hosts/README.md

diff --git a/hosts/README.md b/hosts/README.md
new file mode 100644
index 00000000..26433803
--- /dev/null
+++ b/hosts/README.md
@@ -0,0 +1,7 @@
+## directory structure
+- by-name/<hostname>: configuration which is evaluated _only_ for the given hostname
+- common/: configuration which applies to all hosts
+- modules/: nixpkgs-style modules which may be used by multiple hosts, but configured separately per host.
+    - ideally no module here has effect unless `enable`d
+        - however, `enable` may default to true
+        - and in practice some of these modules surely aren't fully "disableable"