README.md

This commit is contained in:
2026-08-23 17:00:41 +02:00
parent d3e61efd86
commit 7e02c87b91
+13 -5
View File
@@ -47,16 +47,25 @@ Core requirements:
- Hyprland (Wayland session integration) - Hyprland (Wayland session integration)
- Python 3 for scheme/wallpaper tooling - Python 3 for scheme/wallpaper tooling
Make sure to have the newest Quickshell version! As of writing, version `0.2.0.r136.gfb08ece-1`. Here's a list of package dependencies, names are from arch-packages so they
might differ slightly depending on your distro.
```
python python-pillow python-materialyoucolor libnotify cava
app2unit wl-clipboard dconf cliphist python-typer qt6-canvaspainter
python-build python-installer python-hatch python-hatch-vcs cmake ninja
```
Make sure to have the newest Quickshell version! As of writing, version `0.3.1.r1.g0fed22a-1`.
Used by major features (install as needed for your setup): Used by major features (install as needed for your setup):
- `app2unit` (launcher app execution) - `app2unit` (launcher app execution)
- `nmcli` (network integration) - `nmcli` (network integration)
- `brightnessctl`, `ddcutil` (brightness controls) - `brightnessctl`, `ddcutil` (brightness controls)
- `wl-copy`, `swappy` (picker/screenshot flow) - `wl-copy` (clipboard integration)
- `libqalculate` (launcher calculator)
- `PipeWire` + audio stack + `aubio`/`cava` paths for media visualization - `PipeWire` + audio stack + `aubio`/`cava` paths for media visualization
- `libqalculate` (launcher calculator)
- `gsettings` (optional GTK dark/light mode sync) - `gsettings` (optional GTK dark/light mode sync)
## Build and Install ## Build and Install
@@ -180,7 +189,7 @@ Important state/cache files:
- `~/.local/state/zshell/apps.sqlite` - `~/.local/state/zshell/apps.sqlite`
- `~/.cache/zshell/` - `~/.cache/zshell/`
Config is hot-reloaded and saved through `Config/Config.qml` serializers. Top-level sections include: Config is hot-reloaded and saved through the `Config` singleton. Top-level sections include:
- `general` - `general`
- `appearance` - `appearance`
@@ -265,7 +274,6 @@ Note: Template rendering (Jinja2) applies generated colors to `~/.config/zshell/
### `screenshot` — area picker ### `screenshot` — area picker
- `start` — open interactive area picker - `start` — open interactive area picker
- `start-freeze` — freeze screen then pick
### `wallpaper` — wallpaper management ### `wallpaper` — wallpaper management