Skip to content

docs(readme): document Linux download and install - #73

Merged
BunsDev merged 2 commits into
mainfrom
docs/linux-install
May 20, 2026
Merged

docs(readme): document Linux download and install#73
BunsDev merged 2 commits into
mainfrom
docs/linux-install

Conversation

@BunsDev

@BunsDev BunsDev commented May 20, 2026

Copy link
Copy Markdown
Member

Summary

  • Adds an Install on Linux section to README.md pointing users at the prebuilt x86_64 packages published on GitHub Releases (.deb, .rpm, Arch .pkg.tar.zst, and AppImage).
  • Documents per-distro install commands, sha256sum -c verification using the shipped .sha256 files, and notes the cast-codes-cli-* headless variants.
  • Adds a short Build from source on Linux subsection that wires users to ./script/linux/install_runtime_deps + ./script/run, with a note that the installer is Debian-family only.

Test plan

  • Render the README on GitHub and confirm the new section appears between the intro and the existing Build section.
  • Click through to https://github.com/OpenCoven/cast-codes/releases/latest and confirm the four asset filenames in the doc still match what's published.
  • Spot-check one .sha256 verification command end-to-end against a downloaded release asset.

Add an Install on Linux section to the README covering the four
package formats published to GitHub Releases (.deb, .rpm, Arch
pkg.tar.zst, AppImage), sha256 verification, per-distro install
commands, and a build-from-source pointer for non-Debian distros.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings May 20, 2026 12:12

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds Linux installation guidance to the project README, pointing users to GitHub Release assets and providing distro-specific install commands plus a short “build from source” path for Linux.

Changes:

  • Document Linux release asset formats (.deb, .rpm, Arch package, AppImage) and per-distro install commands.
  • Add checksum verification instructions and mention CLI-only/headless package variants.
  • Add “Build from source on Linux” section referencing existing helper scripts.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
@BunsDev
BunsDev merged commit 046d2ef into main May 20, 2026
8 checks passed
@BunsDev
BunsDev deleted the docs/linux-install branch May 20, 2026 12:31
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.

2 participants