From 0dbe011a2e7dda62d3d8c9134f0aafafe3565d32 Mon Sep 17 00:00:00 2001
From: Mohammad Rafiq <rafiq@rrv.sh>
Date: Wed, 21 May 2025 11:21:32 +0800
Subject: [PATCH] docs(README.md): add docs on the modules

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1140d2f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# Modules
+
+The nixosModules and homeModules exposed by this flake are slightly out of the norm.
+
+Option declarations for user specific configuration are kept to:
+
+- homeModules for CLI
+- nixosModules for desktop
+
+System configurations, to this end, should include the window manager, lockscreen, terminal etc. for that system.
+
+These desktop programs will be **configured** in home-manager for each user, but those configurations consult the osConfig variable passed in by home-manager.