detached 8265b22

docs(readme): describe the stack generically instead of naming a specific toolkit

commit
8265b22d028259ca737cec88a06fc6b2e67fcfad
author
brice · · 2026-10-02 04:11 UTC
parent
fbc2306
signature
GPG VerifiedCD88F9E564E0102646FB6077A1A07C7C7C3E349D · arch-gpg Verified for the committer email
1 file · +4 -5
Unified
UnifiedSplit
M README.md +4 -5
@@ -9,13 +9,12 @@ WLTurbo is the transport layer: connection, wire framing, descriptor passing, ob
99 ## Where it fits
1010
1111 ```
12-Application
13-└─ neferclient connection helpers, surfaces, seat, DMA-BUF presentation
14- └─ go-wayland-bindings one package per protocol
15- └─ wlturbo transport and objects (this module)
12+Application or toolkit windows, input, rendering, policy
13+└─ Protocol bindings generated code, one package per protocol
14+ └─ WLTurbo transport and objects (this module)
1615 ```
1716
18-Use WLTurbo directly to speak raw Wayland or to write bindings. For an application, start with [neferclient](https://github.com/bnema/neferclient).
17+Use WLTurbo directly to speak raw Wayland or to write your own bindings or toolkit. Ready-made bindings are available in [go-wayland-bindings](https://github.com/bnema/go-wayland-bindings).
1918
2019 ## Architecture
2120
@@ -9,13 +9,12 @@ WLTurbo is the transport layer: connection, wire framing, descriptor passing, ob
9 ## Where it fits9 ## Where it fits
10 10
11 ```11 ```
12-Application12+Application or toolkit windows, input, rendering, policy
13-└─ neferclient connection helpers, surfaces, seat, DMA-BUF presentation13+└─ Protocol bindings generated code, one package per protocol
14- └─ go-wayland-bindings one package per protocol14+ └─ WLTurbo transport and objects (this module)
15- └─ wlturbo transport and objects (this module)
16 ```15 ```
17 16
18-Use WLTurbo directly to speak raw Wayland or to write bindings. For an application, start with [neferclient](https://github.com/bnema/neferclient).17+Use WLTurbo directly to speak raw Wayland or to write your own bindings or toolkit. Ready-made bindings are available in [go-wayland-bindings](https://github.com/bnema/go-wayland-bindings).
19 18
20 ## Architecture19 ## Architecture
21 20

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 1

Tags 8

↑↓ moveenter openesc close