diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 11 insertions, 11 deletions
@@ -1,8 +1,9 @@ # 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. +own directory. They are three 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. 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. @@ -13,29 +14,28 @@ repos stay independent, this one has no build-time dependency on that one. ## Implementations - volume-osd/ on-screen display for output and input volume - vm-manager/ libvirt VM drawer: state, live stats, snapshots + desktop/ the drawer: sound, mail, VMs, appearance appearance/ wallpaper picker and colour scheme switcher - mail-overview/ unread mail per account, as a waybar count and a drawer window-switcher/ open windows as live previews in a grid, on ALT+TAB Each directory has its own README covering what it does and how to run it. ## Running one - qs -p ./volume-osd + qs -p ./desktop -To start it with the session, from Hyprland: +To start one with the session, from Hyprland: - exec-once = qs -p ~/Programming/GIT/quickshell/volume-osd + exec-once = qs -p ~/Programming/GIT/quickshell/desktop Quickshell uses private Qt APIs, so it must be rebuilt after every Qt update. `qs --version` should report the same Qt as the installed one. Some components ask the compositor for an effect they cannot draw themselves, -such as the blur behind `volume-osd`. Those rules live in the Hyprland config -rather than here, and each component's README gives the block to add. They are -optional: without the rule the component renders without that effect. +such as the blur behind the sound module's OSD. Those rules live in the +Hyprland config rather than here, and each component's README gives the block +to add. They are optional: without the rule the component renders without that +effect. ## License |