aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5d74791..c949047 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,11 @@ Macchiato accent, so it can never render as unreadable.
Phase 1 covers rofi. Later phases extend the same palette to waybar, dunst,
conky, hyprland and quickshell.
+Quickshell reads the palette rather than restating it: `udt-accent` writes
+`~/.cache/wal/udt-palette.qml` from `rofi/udt/palette.rasi`, and the
+components in the `quickshell` repo watch that file, so editing the palette
+here recolours them without a restart.
+
## Layout
rofi/udt/ the theme files
@@ -28,6 +33,27 @@ the pywal cache.
GPLv2 only. See `LICENSE`.
+## Changing the colour scheme
+
+Edit one line in `~/.config/udt/roles.conf`:
+
+ scheme = macchiato
+
+and run `./install.sh`. That file is yours, not the repo's: `install.sh`
+creates it on a first run and never overwrites it, so switching scheme leaves
+the working tree clean.
+
+`install.sh` reloads whatever is running (waybar, kitty, Hyprland, dunst,
+conky), so the switch is visible immediately. Qt and GTK apps only reread a
+theme on startup, so those need restarting by hand. Ships with `macchiato`, `tokyo-night`, `nord` and
+`dracula`; rofi, dunst, conky, waybar, kitty, Firefox and quickshell all
+follow.
+
+A scheme is two files: `palette/<name>.conf` for the colours under the
+scheme's own names, and `palette/roles-<name>.conf` saying what each is for.
+Nothing else needs touching, and `bin/udt-palette --selftest` checks that a
+scheme can satisfy every role before you switch to it.
+
## 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.