The guide now ships as `doc/Rectify_user_guide.pdf` alongside the Markdown
it is rendered from. The PDF is the one to read; the Markdown remains the
source and is authoritative if the two ever disagree.
It is committed rather than built here because rendering it needs a font
store and a headless browser, which no one should have to install in order
to read a guide. The same PDF is downloadable on its own from
https://andykopra.com/Rectify_user_guide.pdf — the macOS disk image holds
the application only.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Documentation:
- The GUI is stated as the primary interface on every platform; the
earlier claim that Linux is CLI-first is gone.
- §2.1 becomes "Installing Rectify" with macOS, Linux, and Windows
subsections, each opening with the public clone of this repository and
the per-session launch commands.
- §3.1's Linux section reaches the depth the Windows one already had:
python3-venv (stock Debian/Ubuntu fails `python3 -m venv` without it),
libxcb packages, QT_QPA_PLATFORM=xcb as the Wayland fallback, a
PYTHONPATH wrapper for launching from any directory, and a .desktop
entry. States plainly that Linux has no packaged deliverable.
- §2.15 lists all three settings paths; §2.3 covers the platform-specific
Open dialog and HEIC thumbnails; Finder/Mac-only phrasing generalized.
- README gains a matching Linux section, and its "pre-built executables"
section no longer promises Linux and Windows binaries that were never
published.
Keyboard notation:
- Both documents print the macOS symbols throughout, with one
substitution rule (Ctrl for ⌘, Alt for ⌥) stated in the guide's §2
preamble and under each shortcut table.
- Every combination is joined with a hyphen on all platforms — ⌘-O,
Ctrl-O, ⇧-⌘-Z, ⌥-⇧ — rather than Apple's tight ⌘O, whose glyphs have
side bearings too small to separate them from the next character.
- shortcuts.py carries this in SECTIONS and _mac_translate; gui.py's
tooltip modifier follows. Display labels only: the QKeySequence
bindings keep Qt's "Ctrl+X" syntax and are untouched.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
