From 855b770ecb1af46e9d448c56e562e7c3911e31b4 Mon Sep 17 00:00:00 2001
From: ChUrl <christoph.urlacher@protonmail.com>
Date: Tue, 9 Aug 2022 22:10:37 +0200
Subject: [PATCH] add a readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..230ed293
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# NixFlake/nixos
+
+This folder contains all the system configurations.
+
+- There is a common configuration used for all systems: ``NixFlake/nixos``
+- Every system has its own special configuration: ``NixFlake/nixos/<hostname>``
+
+When creating a NixOS configuration inside the ``NixFlake/flake.nix`` the common configuration is imported.
+Because the hostname is propagated to the common configuration, it can import the host-specific config by itself.
+
+# NixFlake/home
+
+This folder contains all the home-manager configurations.
+
+- There is a configuration for each user: ``NixFlake/home/<username>``
+- There is a common configuration for all systems of this user: ``NixFlake/home/<username>/<hostname>``
+
+When creating a NixOS configuration inside the ``NixFlake/flake.nix`` the common configuration is imported.
+Because the hostname is propagated to the common configuration, it can import the host-specific config by itself.