Skip to content

Refresh README and user guide feature documentation#397

Merged
cary-rowen merged 9 commits into
blindpandas:developfrom
cary-rowen:docs/update-guide-readme
Jul 12, 2026
Merged

Refresh README and user guide feature documentation#397
cary-rowen merged 9 commits into
blindpandas:developfrom
cary-rowen:docs/update-guide-readme

Conversation

@cary-rowen

Copy link
Copy Markdown
Collaborator

Link to issue number:

N/A

Summary of the issue:

The README and English user guide had drifted from the current application behavior. Some current features were missing from the documentation, some shortcuts were undocumented, and the license metadata did not accurately reflect the project's GPL v2-or-later license.

Description of how this pull request fixes the issue:

  • Updates the README as a high-level project overview:

    • keeps feature descriptions concise
    • adds current major capabilities such as OCR, Bookshelf, web article opening, Wikipedia quick search, structured navigation, highlights, and regex search
    • updates the recommended test command to match the project's uv workflow
    • clarifies the license as GNU GPL version 2 or later
  • Updates the English user guide with detailed user-facing workflows and shortcuts:

    • file menu actions, pinned/recent documents, preferences, and QRD import
    • reader window navigation, reading progress, table of contents focus, and special actions
    • structured navigation keys and the element list
    • document info, reading modes, rendered page view, embedded image commands, and table viewing
    • bookmarks, comments, highlights, saved annotation management, tags, filtering, sorting, and export
    • Bookshelf organization, import, search, bundling, categories, and list shortcuts
    • Open URL, Open URL from clipboard, and Wikipedia quick search
    • OCR engines, OCR options, scan current page, automatic OCR, scan to text file, and image-to-text
    • text-to-speech, voice profiles, media keys, and reading behavior settings
    • page navigation, page labels, jump to line, regex search, and search result navigation
  • Fixes a UI shortcut label mismatch:

    • the highlight selection context menu now shows Ctrl-H, matching the actual shortcut
  • Clarifies project license metadata:

    • updates pyproject.toml to GPL-2.0-or-later
    • adds the GPLv2+ classifier
    • adds an SPDX identifier to LICENSE
    • normalizes the LICENSE text so GitHub can better identify the repository license

Testing performed:

N/A

Known issues with pull request:

N/A

@cary-rowen
cary-rowen marked this pull request as ready for review July 12, 2026 03:34
@cary-rowen
cary-rowen merged commit 59efa09 into blindpandas:develop Jul 12, 2026
3 checks passed
@cary-rowen
cary-rowen deleted the docs/update-guide-readme branch July 12, 2026 03:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant