Wiki: generaliserad — skriven för vem som helst, inte en specifik maskin

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-08-30 12:53:29 +02:00
parent 9d44d24abd
commit 57d681fcb4
3 changed files with 63 additions and 27 deletions

52
Home.md

@@ -2,20 +2,28 @@
![waydock](dock-hero.png)
Modern, resurssnål dock för Wayfire — transparent Plasma 6-känsla,
byggd i Rust/GTK4 som en enda binär. Körs på **brasse-linux01** i
Wayfire-DE-sessionen.
Modern, resurssnål dock för Wayland — transparent Plasma 6-känsla,
byggd i Rust/GTK4 som **en enda binär** (~1,6 MB). Fungerar på
wlroots-baserade compositors (Wayfire, Sway m.fl.) och är byggd med
Wayfire i första rummet.
- **[Installation](Installation)** — en-raders-install, krav, autostart
- **[Konfiguration](Konfiguration)** — configfilen, settings-GUI:t, per skärm
- **[Användning](Användning)** — dagligt bruk + hela configreferensen
- **[Arkitektur](Arkitektur)** — hur appen är byggd (moduler, nyckelbeslut)
- Planen och milstolparna ligger i repot: [`doc/plan.md`](https://gitea.brasse-pc.eu/brasse/waydock/src/branch/master/doc/plan.md)
**Funktioner i korthet:** pinnade appar · fönstergrupper med badges och
indikatorer · konfigurerbara klick-, skroll- och högerklicksbeteenden ·
fönsterlista med peek-förhandsvisning · autohide/dodge · hot corners &
edges · settings-GUI med per-skärm-inställningar · allt i en JSON-config
med live-omladdning.
| Dockan | Inställningar |
|---|---|
| ![dock](dock-closeup.png) | ![settings](settings.png) |
## Kom igång
1. **[Installation](Installation)** — installera, krav, autostart
2. **[Konfiguration](Konfiguration)** — configfilen, settings-GUI:t, per skärm
3. **[Användning](Användning)** — dagligt bruk + kompletta configreferensen
4. **[Arkitektur](Arkitektur)** — hur appen är byggd (för nyfikna/bidragare)
## Snabbstart
```bash
@@ -23,17 +31,23 @@ curl -fsSL https://gitea.brasse-pc.eu/brasse/waydock/raw/branch/master/install.s
waydock # config skapas i ~/.config/waydock/config.json
```
Bygga själv: se [README](https://gitea.brasse-pc.eu/brasse/waydock#beroenden-archgaruda).
## Krav i korthet
## Krav
- En wlroots-compositor med `zwlr_foreign_toplevel_manager_v1`
(Wayfire, Sway, …) — krävs för fönsterlistan
- **Wayfire-extra** (valfritt men rekommenderat): pluginsen `ipc` +
`ipc-rules` ger översiktsknapp, "Flytta till skärm" och dodge-autohide;
`alpha` ger peek-förhandsvisningen
- Äkta fönsterminiatyrer i grupp-popupen är inte möjliga — Wayland-
protokollet för per-fönster-bildfångst
(`ext_foreign_toplevel_image_capture_source_v1`) exponeras inte av
Wayfire ännu
- wlroots-compositor med `zwlr_foreign_toplevel_manager_v1` (Wayfire, Sway …)
- För översikt/flytta-till-skärm/dodge: Wayfires `ipc` + `ipc-rules`-plugins
- Miniatyrer i grupp-popupen är **inte möjliga** — Wayfire exponerar inte
per-fönster-bildfångst (`ext_foreign_toplevel_image_capture_source_v1`)
## Utveckling
## Släpp & CI
CI (Pi5-runnern) kör `cargo check`/`clippy`/`test` på varje push.
Releaser byggs lokalt på brasse-linux01 med `./release.sh vX.Y.Z` som
taggar, bygger x64-binären och skapar Gitea-release + rullande `latest`.
Koden bor på [gitea.brasse-pc.eu/brasse/waydock](https://gitea.brasse-pc.eu/brasse/waydock).
CI kör `cargo check`/`clippy`/`test` på varje push; en `vX.Y.Z`-tagg
bygger release-binären och publicerar den på
[släppsidan](https://gitea.brasse-pc.eu/brasse/waydock/releases)
tillsammans med rullande `latest`. Planen och milstolparna finns i
[`doc/plan.md`](https://gitea.brasse-pc.eu/brasse/waydock/src/branch/master/doc/plan.md).

@@ -22,8 +22,15 @@ waydock
| Wayfires `ipc` + `ipc-rules`-plugins *(valfritt)* | översiktsknappen, "Flytta till skärm", dodge-autohide och peek |
| Wayfires `alpha`-plugin *(valfritt)* | peek-förhandsvisningen (tona ner andra fönster) |
Pluginsen aktiveras i `wayfire.ini` under `[core] plugins = … ipc ipc-rules alpha …`
— Wayfire laddar om configen live, ingen omstart behövs.
Pluginsen aktiveras i `wayfire.ini` under `[core]`:
```ini
[core]
plugins = ... ipc ipc-rules alpha ...
```
Wayfire laddar om configen live, ingen omstart behövs. Utan pluginsen
fungerar docken ändå — funktionerna som kräver dem göms automatiskt.
## Bygga själv
@@ -33,15 +40,29 @@ cd waydock
cargo build --release # binär: target/release/waydock
```
## Starta med Wayfire-sessionen
## Starta automatiskt med sessionen
Lägg ett autostart-skript (i Wayfire-DE: `autostart/11-dock.sh`):
**Wayfire** — lägg till i `wayfire.ini`:
```bash
#!/usr/bin/env bash
exec ~/.local/bin/waydock
```ini
[autostart]
dock = waydock
```
**Sway** — lägg till i `~/.config/sway/config`:
```
exec waydock
```
Eller använd valfri autostart-mekanism (en `.desktop`-fil i
`~/.config/autostart/` följer med installationen).
## Arkitekturer
Release-binären byggs för **linux x86_64**. Andra arkitekturer
(t.ex. arm64) fungerar också — bygg då från källkod enligt nedan.
## Uppdatera
Kör en-raders-installen igen — den hämtar alltid senaste `latest`-releasen.

@@ -32,7 +32,8 @@ som avvikelse, resten ärvs från det globala. `*` = skärmen har egna
inställningar; "Återställ skärmen till globalt" tar bort dem.
I JSON-filen hamnar avvikelserna under `"outputs"`, med skärmens
connector-namn som nyckel:
connector-namn som nyckel (hitta dina med t.ex. `wlr-randr`
eller i settings-GUI:ts skärmväljare):
```jsonc
"outputs": {