From 2a0aedbd67a5e2a767413db1655411d5a9f98017 Mon Sep 17 00:00:00 2001
From: caem <caem@dirae.org>
Date: Sun, 25 Jun 2023 12:44:09 +0200
Subject: [PATCH] Add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ff004ab
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# nixos-system-config
+Modular multi-purpose NixOS configuration.
+
+## About
+Feel free to do whatever with this configuration.  
+This configuration [erases your darlings](https://grahamc.com/blog/erase-your-darlings/) using ZFS snapshots.  
+Currently only used for my homeserver, [desktop runs on Gentoo](https://git.dirae.org/caem/dotfiles).  
+
+## Layout
+```
+/nix/config
+├── flake.lock
+├── flake.nix                   ; Master configuration file
+├── overlays                    ; Package overlays
+├── packages                    ; Packages with configurations
+│   ├── nginx
+│   │   └── homeserver.nix
+│   ├── syncthing
+│   │   └── homeserver.nix
+│   └── vim
+│       └── package.nix
+├── pw                          ; Password of your user
+├── sets                        ; Sets of packages 
+│   └── meta
+│       └── sysadmin.nix
+├── systems                     ; System specific configuration
+│   ├── common.nix
+│   ├── hardware                ; Hardware configuration of each system
+│   │   ├── homeserver.nix
+│   │   └── qemu-vm.nix
+│   ├── homeserver.nix
+│   ├── persist                 ; Persistence configuration of each system
+│   │   ├── common.nix
+│   │   ├── homeserver.nix
+│   │   └── qemu-vm.nix
+│   └── qemu-vm.nix
+└── users                       ; User specific configuration
+    ├── media.nix
+    ├── none.nix
+    └── user.nix
+```