镜像站点 · 本页由第三方 GitHub 只读镜像提供,非 GitHub 官方站点,不接受任何登录或凭据输入。前往 github.com
Skip to content

docs: restructure README after the sendspin-python-cli layout - #112

Merged
chrisuthe merged 1 commit into
mainfrom
chrisuthe/task/restructure-readme-after-the-sendspin-python-cli
Nov 2, 2026
Merged

chrisuthe merged 1 commit into
mainfrom
chrisuthe/task/restructure-readme-after-the-sendspin-python-cli

Conversation

@chrisuthe

Copy link
Copy Markdown
Member

Reshape README.md to follow the sendspin-python-cli README: release and OHF badges, a pitch linking sendspin-audio.com, then Installation, Updating, Pairing, Configuration (per-feature subsections, each with an example and a wiki link), Controlling the player, Running as a service, Uninstall.

  • New Updating section: re-running the guided installer upgrades on Linux and Windows and keeps config and pairings; macOS takes the newer .pkg or tarball.
  • The options table is replaced by the Configuration subsections, which cover the same options without duplicating them.
  • Depth stays in the wiki. Every wiki link and anchor was checked against docs/wiki/.

Only README.md changes.

Compatibility

Nothing breaks for CLI users: documentation only, no flags, config keys, control-socket protocol, state format or defaults change.

@chrisuthe
chrisuthe marked this pull request as ready for review November 2, 2026 17:20
@chrisuthe
chrisuthe merged commit 7a489d5 into main Nov 2, 2026
20 checks passed
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