detached 9f76253

Merge pull request #1 from bnema/docs/readme-screenshot

docs(readme): show the bundled bar on a real desktop
commit
9f762532e7f461d484425cd87710ade666411a8a
author
bnema · · 2026-10-05 18:03 UTC
committer
GitHub · · 2026-10-05 18:03 UTC
merge of
551649b + 3ee465e · diff against the first parent
signature
GPG UnverifiedB5690EEEBB952194 The key is unknown
3 files · +1 -2
M README.md +1 -2
@@ -4,7 +4,7 @@ A dead simple status bar for Wayland: **one line of terminal text, nothing else.
44
55 Each part of the bar is a script. A script prints text, and neferbar shows it. If you can write `echo`, you can write a module.
66
7-![neferbar showing a workspace number, an app name, a clock and system stats, with Nerd Font icons](docs/img/bar.png)
7+![The bundled bar on a NeferWL desktop with a terminal and an empty Firefox: workspaces on the left, the focused app and its title in the middle, the clock on the right](docs/img/bundle.png)
88
99 - **Text only.** ASCII, Unicode and Nerd Font icons. No images, no widgets, no clicks.
1010 - **Exactly one character high.** The bar is as tall as a terminal row, and it follows your monitor's scale.
@@ -179,7 +179,6 @@ neferbar draws at most as often as your monitor refreshes. If a script prints fa
179179
180180 `examples/bundle` is a ready-made bar: workspaces on the left, the focused app in the middle, the clock on the right, in your terminal's colors.
181181
182-![The bundled bar](docs/img/bundle.png)
183182 Copy it to `~/.config/neferbar/` (the install steps are at the top of `examples/bundle/config.toml`).
184183
185184 Its helper `lib.sh` has what a themed script needs: `fg`/`bg` to set a color from `#rrggbb`, `mix` to blend two, `fade` for the soft edge, and `state_changed_loop` to react to NeferWL. Read the three scripts: each is about thirty lines.
@@ -4,7 +4,7 @@ A dead simple status bar for Wayland: **one line of terminal text, nothing else.
4 4
5 Each part of the bar is a script. A script prints text, and neferbar shows it. If you can write `echo`, you can write a module.5 Each part of the bar is a script. A script prints text, and neferbar shows it. If you can write `echo`, you can write a module.
6 6
7-![neferbar showing a workspace number, an app name, a clock and system stats, with Nerd Font icons](docs/img/bar.png)7+![The bundled bar on a NeferWL desktop with a terminal and an empty Firefox: workspaces on the left, the focused app and its title in the middle, the clock on the right](docs/img/bundle.png)
8 8
9 - **Text only.** ASCII, Unicode and Nerd Font icons. No images, no widgets, no clicks.9 - **Text only.** ASCII, Unicode and Nerd Font icons. No images, no widgets, no clicks.
10 - **Exactly one character high.** The bar is as tall as a terminal row, and it follows your monitor's scale.10 - **Exactly one character high.** The bar is as tall as a terminal row, and it follows your monitor's scale.
@@ -179,7 +179,6 @@ neferbar draws at most as often as your monitor refreshes. If a script prints fa
179 179
180 `examples/bundle` is a ready-made bar: workspaces on the left, the focused app in the middle, the clock on the right, in your terminal's colors.180 `examples/bundle` is a ready-made bar: workspaces on the left, the focused app in the middle, the clock on the right, in your terminal's colors.
181 181
182-![The bundled bar](docs/img/bundle.png)
183 Copy it to `~/.config/neferbar/` (the install steps are at the top of `examples/bundle/config.toml`).182 Copy it to `~/.config/neferbar/` (the install steps are at the top of `examples/bundle/config.toml`).
184 183
185 Its helper `lib.sh` has what a themed script needs: `fg`/`bg` to set a color from `#rrggbb`, `mix` to blend two, `fade` for the soft edge, and `state_changed_loop` to react to NeferWL. Read the three scripts: each is about thirty lines.184 Its helper `lib.sh` has what a themed script needs: `fg`/`bg` to set a color from `#rrggbb`, `mix` to blend two, `fade` for the soft edge, and `state_changed_loop` to react to NeferWL. Read the three scripts: each is about thirty lines.
D docs/img/bar.png +0 -0 binary file: no text diff

binary file: no text diff

M docs/img/bundle.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 5

Tags 4

↑↓ moveenter openesc close