docs(README.md): add docs on the modules

This commit is contained in:
Mohammad Rafiq 2025-05-21 11:21:32 +08:00
parent aa9a28fa1c
commit 0dbe011a2e
No known key found for this signature in database

12
README.md Normal file
View file

@ -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.