From ad8f9bafa1d002e0714aaf1b16b90b497d9e5472 Mon Sep 17 00:00:00 2001
From: caem <me@caem.dev>
Date: Sat, 1 Feb 2025 13:41:19 +0100
Subject: [PATCH] Add layout to README

---
 README.md | 36 +++++++++++++++++++++++++++++++++---
 1 file changed, 33 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 7cf088f..47d6926 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,44 @@
-# caenix 
+# caenix
 
 ## Screenshot
 ![Screenshot of my desktop](assets/screenshot.png)
 
 ## Layout
-Work in progress.
+```
+.
+├── .gitattributes
+├── .gitignore
+├── README.md
+├── assets                   ; Binary assets such as screenshots and wallpapers
+│   └── ...
+├── flake.lock
+├── flake.nix
+├── hosts                    ; Host configurations
+│   ├── puter
+│   │   ├── default.nix      ; Host specific configuration options
+│   │   ├── disko.nix        ; Host specific partitioning layout
+│   │   └── packages.nix     ; Host specific package set
+│   └── ...
+├── install.sh
+├── lib                      ; Custom helper functions
+│   └── ...
+├── modules                  ; Configuration modules
+│   ├── home                 ; Home-manager modules
+│   │   └── caem             ; User home-manager modules
+│   │       ├── default.nix  ; User specific configuration options
+│   │       ├── packages.nix ; User specific package set
+│   │       └── ...
+│   └── nixos                ; NixOS modules
+│       ├── user             ; User definition
+│       │   └── caem.nix
+│       └── ...
+└── overlays                 ; Overlays
+    └── ...
+```
 
 ## Installation
 
-### Setting up your secrets repository 
+### Setting up your secrets repository
 
 This step is required to install the system as it is built around nix-sops
 with encrypted files in a private repository in order to not expose even the