docs: reconcile README with actual config and install.sh - #39
Merged
Conversation
Fixes drift between the README (EN+DE) and the actual runtime: - Wrong JSON field names in the example config: base_url -> llm_base_url, compose_signature -> compose_signature_text (must match app/config.py). - Wrong tts_openai_voice default documented (nova, actually marin). - Missing config fields never documented: transcription_hotkey, paste_key_delay_ms, notes_folder, history_size, tts_voice, tts_provider, tts_openai_model, tts_speed. - hotkey_mode example value aligned with the actual code default (hold). - install.sh's interactive hotkey-mode prompt (BLITZTEXT_NO_HOTKEY) was undocumented in "What does the script do?" and "After installation". - Manual-install instructions were missing the CPU-only PyTorch step that scripts/install.sh performs to avoid pulling multi-GB CUDA wheels. CI badge, screenshots, and the upstream blitztext-app attribution link were checked and are already accurate -- left untouched.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
config.json(both EN and DE):base_url→llm_base_url,compose_signature→compose_signature_text— these didn't matchapp/config.pyand would mislead anyone editing the file by hand.tts_openai_voice:nova→marin, matching the real default inapp/config.py).app/config.pybut were never mentioned in the README:transcription_hotkey,paste_key_delay_ms,notes_folder,history_size,tts_voice,tts_provider,tts_openai_model,tts_speed.scripts/install.sh's interactive hotkey-mode prompt (global hotkeys vs. GUI/tray-only,BLITZTEXT_NO_HOTKEYenv var) in the install summary and post-install steps.scripts/install.shactually does to avoid pulling multi-GB CUDA wheels.blitztext-appattribution link — all already correct, left untouched.Implements the roadmap item "README-Qualität nach Repo-Auslagerung prüfen" (Project #10). Two independent Codex review passes were used to verify every claim against
app/config.pyandscripts/install.sh.Test plan
app/config.pyDEFAULTS directlyscripts/install.shdirectly