aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDanilo M. <danix@danix.xyz>2026-10-07 19:13:16 +0200
committerDanilo M. <danix@danix.xyz>2026-10-07 19:13:16 +0200
commita55464e179a3f82aa46866564878ad35e11e0ae5 (patch)
tree7e604416cb2c6c1a22f633a8dc6158d4d30d7e1f /README.md
parentfe80b03136a141fb6832474e7dd6dc0ba822e454 (diff)
downloadquickshell-a55464e179a3f82aa46866564878ad35e11e0ae5.tar.gz
quickshell-a55464e179a3f82aa46866564878ad35e11e0ae5.zip
docs: the island, and waybar gone
AGENTS.md describes the hybrid model (desktop/ hosts drawer and island) and gains the gotchas found while building the island: UseQApplication for tray menus, WheelHandler vs MouseArea, accent colliding with green, xkb layout switching, and the tray popup un-hovering the island. The Blur waybar measurement becomes history. READMEs drop their present-tense waybar references. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index 75059dd..12d7ed7 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,10 @@
# quickshell
Quickshell components for a Hyprland desktop, each one self-contained in its
-own directory. They are separate shells, not modules of a single bar: any of
-them can run alone, and running one does not require the others. One of them,
-`desktop/`, is itself a host for modules, which its own README covers.
+own directory. `desktop/` is the integrated one: a single process hosting the
+drawer and the island, and later a control panel, which its own README covers.
+The rest are separate shells: any of them can run alone, and running one does
+not require the others.
Visually they follow [unified-desktop-theme][udt]: Catppuccin Macchiato as the
fixed base, Noto Sans for UI text, and an accent that tracks the wallpaper.
@@ -15,6 +16,7 @@ repos stay independent, this one has no build-time dependency on that one.
## Implementations
desktop/ the drawer: sound, mail, VMs, appearance
+ island/ top-centre pills: clock, volume, tray, layout, privacy
appearance/ wallpaper picker and colour scheme switcher
window-switcher/ open windows as live previews in a grid, on ALT+TAB
keybinds/ live keybind reminder, on SUPER+k