docs: add keyboard quick-reference to READMEs
ober
996405617f5d5acb20638f0d8979452410d39fb2
--- a/README.md +++ b/README.md @@ -17,9 +17,27 @@ the source of truth; Qt is only a display + input surface. jerboa-browser https://example.com # opens the window, keyboard-driven ``` +## Quick keys (TL;DR) + +No address bar — Jerboa is keyboard-driven (`C-` = Ctrl, `M-` = Alt; `C-h b` +lists every binding): + +| Key | Does | +|-----|------| +| `C-l` | **open a URL** — type in the prompt, press Enter | +| `M-l` | open a URL in a new buffer (tab) | +| `C-t` / `C-x C-k` | new buffer (tab) / close current | +| `M-n` / `M-p` | next / previous buffer | +| `C-r` · `C-b` / `C-f` | reload · history back / forward | +| `C-s` · `f` | find on page · follow a link by hint | +| `M-x` · `C-h b` | run a command by name · list all keys | +| `C-x C-c` | quit | + ## Keyboard (emacs keyscheme) -The minibuffer line doubles as the echo area; the status line shows +There is no address bar: `C-l` opens a URL prompt in the minibuffer — type the +URL (scheme optional; bare hosts become `https://…`) and press Enter, or `C-g` +to cancel. The minibuffer line doubles as the echo area; the status line shows `[modes] [i/n] title — url`. `C-g` aborts a half-typed chord, a prompt, or hint-mode. `C-h b` opens a buffer listing every binding. --- a/packaging/linux/build-tarball.sh +++ b/packaging/linux/build-tarball.sh @@ -109,6 +109,21 @@ Run it: ./bin/jerboa-browser repl Jerboa REPL with (browser) preloaded headless smoke (no window): QT_QPA_PLATFORM=offscreen JWB_BROWSE_MS=1500 ./bin/jerboa-browser example.com +Keys (Emacs-style: C-=Ctrl, M-=Alt; a space is a chord, e.g. C-x b is + C-x then b. C-g aborts anything.): + C-l open a URL (there's no address bar — type in the prompt, Enter) + M-l open a URL in a new buffer (tab) + C-t new buffer (tab) + C-x C-k close current buffer + M-n / M-p next / previous buffer + C-r reload + C-b / C-f back / forward in history + C-v / M-v scroll page down / up + C-s find on page + f follow a link by on-screen hint + C-x C-c quit + C-h b show ALL key bindings M-x run any command by name + Prerequisite: Qt 6 WebEngine runtime installed system-wide (e.g. apt install qt6-webengine-dev libqt6webenginewidgets6, or distro equivalent). The Chromium sandbox is left enabled.