detached 36532eb

docs(readme): describe the current state and tested hardware

commit
36532ebe3b74e58864382dc9e791cea108596fcc
author
brice · · 2026-09-25 10:00 UTC
parent
0a85a4e
signature
GPG VerifiedCD88F9E564E0102646FB6077A1A07C7C7C3E349D · arch-gpg Verified for the committer email
1 file · +7 -1
M README.md +7 -1
@@ -1,9 +1,15 @@
11 # NeferTTY
22
3-NeferTTY is a minimal Wayland compositor in Go with Niri-style scrollable columns. This repository currently contains only the skeleton and logging.
3+NeferTTY is a minimal Wayland compositor in Go with Niri-style scrollable columns. It runs on a TTY (DRM/KMS, libinput, Vulkan) or headless.
44
55 Requires Linux and Go 1.27.
66
7+## Hardware support
8+
9+- **AMD GPUs:** developed and tested on AMD (radv).
10+- **NVIDIA GPUs:** untested. NVIDIA drivers need explicit sync (`linux-drm-syncobj`), which NeferTTY does not implement yet. Testers with NVIDIA hardware are welcome to report issues or contribute.
11+- **Intel GPUs:** untested.
12+
713 Build: `make build` (requires sibling checkouts of purego-libwayland and purego-vulkan).
814
915 Run: `nefertty --backend=headless --timeout 5s`
@@ -1,9 +1,15 @@
1 # NeferTTY1 # NeferTTY
2 2
3-NeferTTY is a minimal Wayland compositor in Go with Niri-style scrollable columns. This repository currently contains only the skeleton and logging.3+NeferTTY is a minimal Wayland compositor in Go with Niri-style scrollable columns. It runs on a TTY (DRM/KMS, libinput, Vulkan) or headless.
4 4
5 Requires Linux and Go 1.27.5 Requires Linux and Go 1.27.
6 6
7+## Hardware support
8+
9+- **AMD GPUs:** developed and tested on AMD (radv).
10+- **NVIDIA GPUs:** untested. NVIDIA drivers need explicit sync (`linux-drm-syncobj`), which NeferTTY does not implement yet. Testers with NVIDIA hardware are welcome to report issues or contribute.
11+- **Intel GPUs:** untested.
12+
7 Build: `make build` (requires sibling checkouts of purego-libwayland and purego-vulkan).13 Build: `make build` (requires sibling checkouts of purego-libwayland and purego-vulkan).
8 14
9 Run: `nefertty --backend=headless --timeout 5s`15 Run: `nefertty --backend=headless --timeout 5s`

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