The complete documentation for star — Speaking Terminal Access Reader. For
the project introduction and quick install, see the root
README.md.
| Document | What's in it |
|---|---|
| Installation | Requirements, install from PyPI / wheel / zipapp, optional packages, native engines, platform notes |
| Usage Guide | Running star, the quick command reference (feature → menu · shortcut · TUI command), full keyboard map, M-x commands, screen layout, CLI options |
| Features | The complete feature reference — TTS backends, highlighting, notes, citations, export, study aids, themes, and more |
| Knowledge Graph | Typed relations between annotations, concept extraction, the interactive graph view, and SVG/PlantUML/DOT/JSON export |
| Obsidian Vaults | Import an Obsidian vault into the knowledge graph and export the graph back out as linked Markdown notes |
| Karaoke Video Export | Produce a sentence-synchronized karaoke MP4 video from any document |
| Configuration | Every settings.json key and its default |
| Architecture & Contributing | Package layout, the star/gui/ package, distribution artifacts, contributing, and the test suite |
| Developing Plugins | Writing entry-point plugins that add a TTS voice engine, a new document format, or an export target — the plugin API contract, packaging as a pip distribution, and a copy-me template |
| Performance & Large Documents | Runtime hot paths, word-map and pagination optimizations for large documents, and how to reproduce the measurements |
| Keyboard & Focus Audit | Every Qt-GUI shortcut, the tab/focus order through window/docks/dialogs, and WCAG 2.1.1 / 2.4.3 conformance notes |
Maintainer-only:
| Document | What's in it |
|---|---|
| Releasing | The release runbook (tagging, CI, PyPI publishing) |
| Packaging & Distribution | Every way star is packaged and shipped — wheel/sdist, the .pyz, GPG signatures, and the optional native Windows/macOS/Linux installer jobs |
Also bundled with the package: star/CHANGELOG.md (full
change history) and star/BUILD.md (building the wheel and the
self-contained Windows star.exe).