From ec2f9e379aacb91da21b76925071d1f88fffb16c Mon Sep 17 00:00:00 2001
From: Ahmad Ansori Palembani <palembani@gmail.com>
Date: Fri, 18 Oct 2024 21:12:15 +0700
Subject: [PATCH] docs(nix): Structure

---
 .config/nix/README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/.config/nix/README.md b/.config/nix/README.md
index 5e738c3..2b0c9ec 100644
--- a/.config/nix/README.md
+++ b/.config/nix/README.md
@@ -2,6 +2,33 @@
 
 You need to install Nix before following this guide: `sh <(curl -L https://nixos.org/nix/install)` and symlink this dir to `~/.config/nix`
 
+## Structure
+
+```
+├── flake.lock
+├── flake.nix
+├── lib                 # Self-explanatory, it contains helper functions
+│   ├── mkCommon.nix
+│   └── mkSystem.nix
+├── modules             # Contains shared configuration across system, across user
+│   └── home-manager
+│       └── floorp.nix
+├── systems             # Contains configurations depending on what type OS nix is being used in
+│   ├── darwin          # macOS
+│   │   ├── configuration.nix
+│   │   └── default.nix
+│   └── nix             # Linux-alike
+│       ├── default.nix
+│       └── potato
+│           └── default.nix
+└── users               # Contains configurations for multi-user setup
+    ├── default.nix
+    └── ziro
+        ├── darwin.nix
+        ├── default.nix
+        └── linux.nix
+```
+
 ## Setup
 
 ### macOS