aboutsummaryrefslogtreecommitdiff
path: root/home/rices/finals/README.md
diff options
context:
space:
mode:
authorNatasha Moongrave <natasha@256phi.eu>2026-04-20 11:34:55 +0200
committerNatasha Moongrave <natasha@256phi.eu>2026-04-20 11:34:55 +0200
commit8a47c7ebcd39c32e3b566d0ed1b645a82b55f9e3 (patch)
treedb45b4b7cfc664334a66c8df0ca27623fabf185e /home/rices/finals/README.md
parenta4bc3ae3780298b2f73379812d0cad03589861cc (diff)
Add boilerplate for a niri rice (The Finals theemd)
Diffstat (limited to 'home/rices/finals/README.md')
-rw-r--r--home/rices/finals/README.md58
1 files changed, 58 insertions, 0 deletions
diff --git a/home/rices/finals/README.md b/home/rices/finals/README.md
new file mode 100644
index 0000000..153fd35
--- /dev/null
+++ b/home/rices/finals/README.md
@@ -0,0 +1,58 @@
+# finals
+
+NixOS rice built on **Niri** (Wayland compositor). Minimal boilerplate — extend as needed.
+
+## Stack
+
+| Component | Choice |
+|-----------|--------|
+| Compositor | [Niri](https://github.com/YaLTeR/niri) (Wayland) |
+| Terminal | Kitty |
+| Launcher | Fuzzel |
+| Notifications | Dunst |
+| Lock Screen | Swaylock + Swayidle |
+| Theme Engine | [Stylix](https://github.com/danth/stylix) |
+
+## Structure
+
+```
+.
+├── default.nix # Entry point — imports system + home
+├── system.nix # System-level config (Niri, Pipewire, Stylix, fonts)
+├── home.nix # Home Manager config (packages, GPG agent)
+├── terminal.nix # Kitty config
+├── notifications.nix # Dunst config
+├── fuzzel.nix # Launcher config
+├── niri.nix # Niri compositor config (KDL generation)
+├── stylix.nix # Theme overrides
+├── swayidle.nix # Lock screen integration
+└── niri/
+ └── kdl/ # Niri config modules
+ ├── binds.kdl # Keybindings
+ ├── style.kdl # Window styling
+ └── input.kdl # Keyboard/mouse/touchpad
+```
+
+## Key Bindings
+
+| Bind | Action |
+|------|--------|
+| `Mod+Return` | Kitty |
+| `Mod+D` | Fuzzel launcher |
+| `Mod+N` | Firefox |
+| `Mod+hjkl` | Focus window (vim dirs) |
+| `Mod+Shift+hjkl` | Move window |
+| `Mod+1-5` | Switch workspace |
+| `Mod+Ctrl+1-5` | Move to workspace |
+| `Mod+F` | Maximize column |
+| `Mod+Ctrl+F` | Fullscreen |
+| `Mod+Space` | Overview |
+
+## Not Yet Included
+
+- Bar (eww/waybar)
+- Browser module
+- Custom shaders/animations
+- Wallpaper setup
+- Per-app window rules
+- Screen capture privacy rules