From c4451212c8421442a96ef238494c4548d78c7798 Mon Sep 17 00:00:00 2001
From: jacekpoz <jacekpoz@cock.li>
Date: Thu, 15 Feb 2024 17:52:59 +0100
Subject: [PATCH] add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..77f209c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# niksos
+
+a modular flake containing configurations for most of my machines
+
+I try to keep this simple so other people can learn from my config :-)
+
+## directory structure
+```
+niksos/
+├───hosts/          (machine specific configuration)
+│   ├───chmura/         (homeserver)
+│   ├───hape/           (HP laptop - WIP)
+│   └───niks/           (main laptop)
+├───modules/        (custom modules you can enable under `myOptions`)
+├───options/        (unconditional modules imported in `hosts/*/profile.nix`)
+│   ├───common/         (options shared between most or all systems)
+│   ├───desktop/        (desktop specific options + tablet / mobile)
+│   └───server/         (server specific options)
+└───secrets/        (agenix secrets)
+```
+
+## cool flakes
+flakes I ~~stole~~ took inspiration from
+
+https://git.notashelf.dev/NotAShelf/nyx
+<br>
+https://github.com/n3oney/nixus
+<br>
+https://github.com/sioodmy/dotfiles
+<br>
+https://github.com/RadovanSk/Faery/
+<br>
+https://github.com/fufexan/dotfiles/
+<br>
+https://github.com/ardishco-the-great/nixcfg/
+<br>
+https://github.com/roastedcheese/nicks
+
+## license
+public domain steal all you want just don't copy paste the whole flake and say you made it thanks :-)