From 5fe2777acda756ae69f59e084afd9f6d35a535da Mon Sep 17 00:00:00 2001
From: seth <getchoo@tuta.io>
Date: Fri, 5 Jul 2024 07:30:49 -0400
Subject: tree-wide: document most things

---
 modules/README.md        |  6 ++++++
 modules/darwin/README.md | 17 +++++++++++++++++
 modules/nixos/README.md  | 21 +++++++++++++++++++++
 modules/shared/README.md |  9 +++++++++
 4 files changed, 53 insertions(+)
 create mode 100644 modules/README.md
 create mode 100644 modules/darwin/README.md
 create mode 100644 modules/nixos/README.md
 create mode 100644 modules/shared/README.md

(limited to 'modules')

diff --git a/modules/README.md b/modules/README.md
new file mode 100644
index 0000000..7e45a1f
--- /dev/null
+++ b/modules/README.md
@@ -0,0 +1,6 @@
+# ./modules/
+
+These directory names are probably self explanatory
+
+In case they aren't: `darwin/` contains nix-darwin modules, `nixos/` contains
+NixOS modules, and `shared` contains modules I use on both!
diff --git a/modules/darwin/README.md b/modules/darwin/README.md
new file mode 100644
index 0000000..249286c
--- /dev/null
+++ b/modules/darwin/README.md
@@ -0,0 +1,17 @@
+# ./modules/darwin/
+
+## archetypes
+
+The high-level "type" of a machine (i.e., `personal` or `server`)
+
+## base
+
+Low level options shared for (almost) any kind of system
+
+## desktop
+
+Installs cool GUI stuff for desktops...or laptops too I guess
+
+## traits
+
+Small, reusable aspects of a machine - like users
diff --git a/modules/nixos/README.md b/modules/nixos/README.md
new file mode 100644
index 0000000..5a78133
--- /dev/null
+++ b/modules/nixos/README.md
@@ -0,0 +1,21 @@
+# ./modules/nixos/
+
+## archetypes
+
+The high-level "type" of a machine (i.e., `personal` or `server`)
+
+## base
+
+Low level options shared for (almost) any kind of system
+
+## desktop
+
+Installs cool GUI stuff for desktops...or laptops too I guess
+
+## server
+
+Installs cool daemons and such for servers
+
+## traits
+
+Small, reusable aspects of a machine - like users
diff --git a/modules/shared/README.md b/modules/shared/README.md
new file mode 100644
index 0000000..9228717
--- /dev/null
+++ b/modules/shared/README.md
@@ -0,0 +1,9 @@
+# ./modules/shared/
+
+## base
+
+Low level options shared for (almost) any kind of system
+
+## traits
+
+Small, reusable aspects of a machine - like users
-- 
cgit v1.2.3