1 files changed, 39 insertions, 0 deletions
diff --git a/hypr/README.md b/hypr/README.md
new file mode 100644
index 0000000..90a5f4d
--- /dev/null
+++ b/hypr/README.md
@@ -0,0 +1,39 @@
+# Hyprland integration
+
+`dashboard.lua` is a section for the Lua-based Hyprland config in
+`~/.config/hypr/`. It is not sourced automatically; wire it in once:
+
+    ln -s ~/Programming/GIT/conky-theme-udt/hypr/dashboard.lua \
+          ~/.config/hypr/sections/dashboard.lua
+
+and add to `~/.config/hypr/hyprland.lua`:
+
+    require("sections.dashboard")
+
+## One change to make by hand
+
+`sections/autostart.lua` runs `hl.exec_cmd("conky")`, which starts the old
+desktop-layer conky. The dashboard replaces it, so change that line to:
+
+    hl.exec_cmd("conky -c ~/.config/conky/conky.conf")
+
+Leaving both would run two conky instances.
+
+## Bindings
+
+`SUPER+S` toggles the dashboard. `SUPER+D` is already taken by the unnamed
+special workspace, and that workspace also hosts the btop scratchpad, which is
+why the dashboard uses its own `special:dash`.
+
+The bind is written with a literal `"SUPER"` rather than `hl.mainMod`:
+`keybindings.lua` declares `mainMod` as a file-local, so it is not visible to
+other sections.
+
+## Rule keys
+
+`workspace`, `float`, `border_size` and `rounding` are all used by existing
+rules in `sections/look_and_feel.lua` and `sections/workspaces.lua`, so their
+spelling is confirmed. `fullscreen` and `no_focus` are not used anywhere else
+in this config; if the Lua runtime ignores them, the dashboard still lands on
+`special:dash` and can be sized with
+`size = "(monitor_w) (monitor_h)"` instead.