aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDanilo M. <danix@danix.xyz>2026-09-15 13:57:04 +0200
committerDanilo M. <danix@danix.xyz>2026-09-15 13:57:04 +0200
commit20bb69d641c5242d026df5d3fcc9681064758ad6 (patch)
treee818c0a9423ed70b6e59756d7b5b598aeb3df3f0 /README.md
parentcbe4f39ab8b81f247b587347343297631cc020dc (diff)
downloadnotifyd-20bb69d641c5242d026df5d3fcc9681064758ad6.tar.gz
notifyd-20bb69d641c5242d026df5d3fcc9681064758ad6.zip
docs: add the install and handover runbook
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index 75ee960..d93968a 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,25 @@ is the only thing that talks back over D-Bus.
The design and the exact file contract are in the quickshell repo, at
`docs/superpowers/specs/2026-09-15-notification-daemon-design.md`.
+## Install and handover
+
+Build and install the two binaries and the script, beside the statusctl CLI:
+
+ go build -o ~/bin/notifyd ./cmd/notifyd
+ go build -o ~/bin/notifyctl ./cmd/notifyctl
+ install -m 755 scripts/notify-snooze.sh ~/bin/notify-snooze.sh
+
+dunst is not removed until this proves itself. To switch:
+
+1. Stop dunst (`pkill -x dunst` or its service) so the bus name is free.
+2. Add `hl.exec_cmd("notifyd")` to `~/.config/hypr/sections/autostart.lua`,
+ beside the quickshell lines.
+3. Change `rofipass`'s one `dunstctl close-all` to `notifyctl close-all`.
+4. Start `notifyd` and send a test notification.
+
+The renderer that draws the balloons is a separate plan; until it ships the
+queue is visible through `notifyctl list`.
+
## Development Approach
This project is developed using AI-assisted tools. Code is generated with the help of AI based on human-provided specifications, design decisions, and iterative feedback.