Skip to content

Clarify README languages section, add Linux downloads#21

Merged
JosephMaynard merged 2 commits into
masterfrom
feat/v0.19-readme
Jul 21, 2026
Merged

Clarify README languages section, add Linux downloads#21
JosephMaynard merged 2 commits into
masterfrom
feat/v0.19-readme

Conversation

@JosephMaynard

@JosephMaynard JosephMaynard commented Jul 21, 2026

Copy link
Copy Markdown
Owner

Addresses the README review comments deferred from #19, plus a related fix:

  • Languages section: clarify the first-run picker requires confirmation (dismissing does not save a choice), and note that saved-match and custom-screen titles are also shown untranslated, alongside team names/abbreviations/venues.
  • Download table: add the Linux .deb and .rpm rows, since those are now published.

Docs only.

Summary by CodeRabbit

  • Documentation
    • Added Linux download options for Debian/Ubuntu (.deb) and Fedora/RHEL (.rpm).
    • Clarified first-launch language selection and what happens when the prompt is dismissed.
    • Explained that language settings apply to the operator dashboard and on-air graphics, while user-entered text is never translated.
    • Added build-from-source release notes for tagged releases, including automatic Linux package builds.

Addresses the deferred review comments on the languages section: note
that the first-run picker requires confirmation (dismissing does not
save a choice) and that saved-match and custom-screen titles are also
shown untranslated. Adds the Linux .deb/.rpm rows to the download
table now that those are published.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 66532321-4908-4fa5-9e37-857472942e42

📥 Commits

Reviewing files that changed from the base of the PR and between 22f352b and ed7ede9.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

README.md now documents Linux package downloads, automatic Linux artifacts for tagged releases, and first-launch language selection behavior across the dashboard, graphics, and user-entered text.

Changes

README documentation updates

Layer / File(s) Summary
Linux download entries
README.md
The download table and build instructions now include Debian/Ubuntu .deb and Fedora/RHEL .rpm packages, including automatic builds for tagged releases.
Language behavior documentation
README.md
The Languages section describes language prompting, dismissal and re-prompting, dashboard and graphics scope, and untranslated user-entered text.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly reflects the README language clarification and Linux download additions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/v0.19-readme

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 52-53: Update the tagged-release platform description in README.md
to include Linux alongside Windows and macOS, matching the documented .deb and
.rpm artifacts and the release workflow uploads. Leave the package table
unchanged.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0fa4411b-a19c-47b2-9fc2-a8a721ab7845

📥 Commits

Reviewing files that changed from the base of the PR and between eb88c57 and 22f352b.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
The release workflow also builds .deb and .rpm artifacts (and the
download table already lists them), but the prose still named only
Windows and macOS. Addresses the CodeRabbit review comment on this PR.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@JosephMaynard
JosephMaynard merged commit 0a1856e into master Jul 21, 2026
4 checks passed
@JosephMaynard
JosephMaynard deleted the feat/v0.19-readme branch July 21, 2026 13:04
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