readme: document the fork and /etc/wldash/config.yml precedence

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
This commit is contained in:
Bendik Aagaard Lynghaug
2026-10-03 09:15:57 +00:00
co-authored by Claude Fable 5.1
parent eea3a78140
commit 856f8d8bf4
+11 -2
View File
@@ -10,14 +10,23 @@ Consider this alpha-quality: While it works, *everything* is subject to change w
wldash has received a significant rewrite. The old version is available in the wldash1 branch for now.
## This fork
This is a maintained fork of [kennylevinsen/wldash](https://github.com/kennylevinsen/wldash)
living at <https://project.uhhm.no/bl/wldash>. On top of upstream it fixes a number of
crashes (non-ASCII input in the launcher, machines without a backlight, battery or
PulseAudio, key-repeat rate 0, ...), corrects redraw damage tracking, and prefers a
machine-local `/etc/wldash/config.yml` over the per-user config when present, which keeps
per-host layouts apart on NFS-shared homes.
## How to use
1. Checkout: `git clone https://github.com/kennylevinsen/wldash`
1. Checkout: `git clone https://project.uhhm.no/bl/wldash`
2. Build: `cargo build --release`
3. Put somewhere: `cp target/release/wldash /usr/local/bin/wldash`
4. Run: `wldash`
To generate a new default configuration, run `wldash --write-default-config`. To configure, edit `$XDG_CONFIG_HOME/wldash/config.yml` (or if `XDG_CONFIG_HOME` is not set, `~/.config/wldash/config.yaml`).
To generate a new default configuration, run `wldash --write-default-config`. To configure, edit `$XDG_CONFIG_HOME/wldash/config.yml` (or if `XDG_CONFIG_HOME` is not set, `~/.config/wldash/config.yml`). If `/etc/wldash/config.yml` exists it takes precedence over the per-user file; `--config FILE` overrides both.
To regenerate the desktop file cache, run `wldash --desktop-refresh`.