From 2aebbdd5e89e483b04a06df03231b68ed2fa39a0 Mon Sep 17 00:00:00 2001
From: DerGrumpf <p.keier@beyerstedt-it.de>
Date: Fri, 3 Apr 2026 23:32:54 +0200
Subject: [PATCH] Init

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..74d6a14
--- /dev/null
+++ b/README.md
@@ -0,0 +1,88 @@
+# DerGrumpfs Nix Configuration
+
+A unified Nix configuration for both NixOS and macOS using flakes, nix-darwin, and Home Manager.
+
+## About
+
+A single repository managing both machines declaratively with Nix. Shared home-manager configuration across platforms with platform-specific modules where needed.
+
+**Author:** Phil Keier
+
+## Machines
+
+| Hostname | Platform | Architecture |
+|----------|----------|--------------|
+| cyper-desktop | NixOS | x86_64-linux |
+| cyper-mac | macOS | x86_64-darwin |
+
+## Prerequisites
+
+### NixOS
+Nix is available out of the box. Enable flakes in your configuration.
+
+### macOS
+Install Nix using the [Determinate Systems installer](https://docs.determinate.systems/#products).
+
+**Note:** Homebrew is managed declaratively via nix-homebrew — if already installed it will auto-migrate, otherwise it is installed automatically.
+
+## Quick Start
+
+### Clone
+```bash
+git clone https://github.com/DerGrumpf/nix ~/.config/nix
+cd ~/.config/nix
+```
+
+### Customize
+
+Replace placeholders in `home/git.nix`:
+- `DerGrumpf` → your Git username
+- `p.keier@beyerstedt-it.de` → your Git email
+
+### Apply
+```bash
+# NixOS
+sudo nixos-rebuild switch --flake .#cyper-desktop
+
+# macOS
+darwin-rebuild switch --flake .#cyper-mac
+
+# Or after initial setup on either machine
+nix-switch
+```
+
+## Project Structure
+```mermaid
+graph TD
+    flake[flake.nix] --> desktop[nixosConfigurations\ncyper-desktop]
+    flake --> mac[darwinConfigurations\ncyper-mac]
+
+    desktop --> nixos[nixos/\nNixOS system modules]
+    desktop --> hd[hosts/cyper-desktop/\nhardware + networking]
+    desktop --> home[home/\nshared home-manager]
+
+    mac --> darwin[darwin/\nmacOS system modules]
+    mac --> hm[hosts/cyper-mac/\nhost specific]
+    mac --> home
+
+    home --> shared["shared\npackages, git, shell, python\nnixvim, nixcord, spicetify\nfloorp, obsidian"]
+    home --> deskmod[desktop/]
+
+    deskmod --> dlinux["Linux only\nhyprland, niri\nwaybar, rofi\ngtk, qt, onlyoffice\nxdg, waypaper"]
+    deskmod --> dmac["macOS only\nsketchybar"]
+```
+
+## Secrets
+
+Secrets are managed with [sops-nix](https://github.com/Mic92/sops-nix) and age encryption. The age key must be present at:
+
+- **Linux:** `~/.config/sops/age/keys.txt`
+- **macOS:** `~/.config/sops/age/keys.txt`
+
+## Useful Links
+
+- [Nix manual](https://nixos.org/manual/nix/stable/)
+- [nix-darwin docs](https://github.com/LnL7/nix-darwin)
+- [Home Manager options](https://nix-community.github.io/home-manager/options.html)
+- [sops-nix](https://github.com/Mic92/sops-nix)
+- [nixvim](https://github.com/nix-community/nixvim)