docs: README overhaul + one-command install (scripts/install.sh)#79
Open
kiki830621 wants to merge 2 commits into
Open
docs: README overhaul + one-command install (scripts/install.sh)#79kiki830621 wants to merge 2 commits into
kiki830621 wants to merge 2 commits into
Conversation
Fixes accumulated drift a new user would hit: a duplicated FluidAudio supply-chain paragraph (merge artifact), the reference-catalog section still claiming mlx-audio was removed (seven families are measured and routable through the adapter since the external-engine work), the Chinese-family backends missing from the list, a stale benchmarks.json mention (the BCNF store replaced it), a 2-backend flag table (there are six), and 200+ tests (311). Structure: Quick start now follows Install directly (Backends moved after it), with first-run download expectations stated up front. scripts/install.sh builds with a known-good toolchain (auto-detects the swiftly 6.2.4 crash case), installs to ~/bin or PREFIX, and smoke-tests via list-backends - verified end-to-end on this machine.
…kills The repo doubles as a Claude Code plugin marketplace but the README never said how an agent installs it, and the plugin needs the CLI on PATH - the new section documents both layers (plugin install + install.sh) and names the three consumption surfaces (CLI, agent skills, MCP tracked as future work). marketplace.json's plugin description was missing the transcript skill entirely.
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
以「新使用者照 README 跑起來」視角翻修：
Verification
install.sh 端到端實測（build→install→驗證→PATH 提示）；README 全接縫通讀；機械 asserts（重複段清除、過時句移除、段落順序）。