detached 2470c88

docs(readme): add demo video and poster

commit
2470c88185dd9feb409f8d4845e16d57b7b40189
author
brice · · 2026-10-21 04:47 UTC
parent
f7cd1e3
signature
GPG VerifiedCD88F9E564E0102646FB6077A1A07C7C7C3E349D · arch-gpg Verified for the committer email
4 files · +2 -2
M README.md +2 -2
@@ -8,8 +8,8 @@
88
99 <p align="center">A Wayland compositor that spends its frames on your apps, not on itself.</p>
1010
11-<!-- demo: docs/media/demo.mp4 -->
12-_Demo video coming soon._
11+<p align="center"><a href="docs/media/demo.mp4"><img src="docs/media/demo.png" alt="NeferWL demo: tiling, stash and overview" width="800"></a></p>
12+<p align="center"><sub>Stash, overview and animations, recorded on the headless backend at 1080p.</sub></p>
1313
1414 > [!WARNING]
1515 > **Early alpha, but stable enough for daily use.** Developed and tested mostly on AMD CPUs and GPUs. NVIDIA support is incomplete and untested (contribs welcome). Expect bugs and breaking config changes.
@@ -8,8 +8,8 @@
8 8
9 <p align="center">A Wayland compositor that spends its frames on your apps, not on itself.</p>9 <p align="center">A Wayland compositor that spends its frames on your apps, not on itself.</p>
10 10
11-<!-- demo: docs/media/demo.mp4 -->11+<p align="center"><a href="docs/media/demo.mp4"><img src="docs/media/demo.png" alt="NeferWL demo: tiling, stash and overview" width="800"></a></p>
12-_Demo video coming soon._12+<p align="center"><sub>Stash, overview and animations, recorded on the headless backend at 1080p.</sub></p>
13 13
14 > [!WARNING]14 > [!WARNING]
15 > **Early alpha, but stable enough for daily use.** Developed and tested mostly on AMD CPUs and GPUs. NVIDIA support is incomplete and untested (contribs welcome). Expect bugs and breaking config changes.15 > **Early alpha, but stable enough for daily use.** Developed and tested mostly on AMD CPUs and GPUs. NVIDIA support is incomplete and untested (contribs welcome). Expect bugs and breaking config changes.
A docs/media/demo.gif +0 -0 binary file: no text diff

binary file: no text diff

A docs/media/demo.mp4 +0 -0 binary file: no text diff

binary file: no text diff

A docs/media/demo.png +0 -0 binary file: no text diff

binary file: no text diff

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 25

Tags 10

↑↓ moveenter openesc close