From 4eadd91af2aa87bb5b5ab72199f96136caa9b09b Mon Sep 17 00:00:00 2001
From: CherryKitten <sammy@cherrykitten.dev>
Date: Sun, 24 Mar 2024 19:03:47 +0100
Subject: [PATCH] add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cf1d7bb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+This repository includes my NixOS and Home-manager configurations.
+
+The repo is organized as follows:
+```
+.
+├── flake.lock
+├── flake.nix
+├── hosts # NixOS-configurations
+│   ├── bengal # Host-specific
+│   │   ├── default.nix
+│   │   └── hardware-configuration.nix
+│   ├── common # General, imported by all hosts
+│   │   ├── default.nix
+│   │   ├── graphical.nix
+│   │   ├── security.nix
+│   │   ├── users.nix
+│   │   ├── virtualization.nix
+│   │   └── yubikey.nix
+├── misc # just some stuff 
+├── modules # Home-manager and NixOS modules that follow upstream standards, currently empty lol
+│   ├── home
+│   └── nixos
+└── users # Home-Manager configurations
+    ├── common # General, imported by all
+    ├── sammy.nix # User-specific, but not Host-specific
+    └── sammy@chansey.nix User- and Host-specific
+```