Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

System requirements

  • X11 session (not Wayland)
  • AT-SPI D-Bus service — usually ships with your desktop. Verify: 
    systemctl --user status at-spi-dbus-bus.service
  • Rust toolchain (install via rustup): 
    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  • System packages: 
    sudo apt install xdotool libgtk-3-dev librsvg2-dev
  • For the OCR backend: sudo apt install clang libclang-dev
  • A compositor recommended (tested with picom on i3)

Build

git clone https://github.com/smllb/qhints-rs
cd qhints-rs
cargo build --release

Binary at target/release/qhints-rs.

For OCR support (optional):

cargo build --release --features ocr

Note: The OCR backend downloads ~35MB of models (text-detection.rten, text-recognition.rten) from AWS S3 on first run to ~/.cache/qhints/ocrs/.

Or install directly from git:

cargo install --git https://github.com/smllb/qhints-rs

Keybinding

Bind to a shortcut in your WM config. i3 example:

bindsym ctrl+shift+p exec --no-startup-id /home/you/qhints-rs/target/release/qhints-rs

You can also use the wrapper script at scripts/run-qhints.sh (logs to syslog).