docs: add demo audio + comparison table to README#21
Merged
Conversation
Two visibility wins for the public face of the repo: - docs/demo.wav: 5 seconds of two stackvox voices (af_heart and bf_emma) speaking the tagline, generated locally with the cached Kokoro model. 234 KB at 24kHz PCM_16 — small enough to commit and serve via the GitHub raw URL. Linked from the top of the README so first-time visitors can hear the tool without installing anything. - README "How does this compare to other TTS?" section comparing stackvox against `say`, `espeak-ng`, Piper, Coqui TTS, and the cloud APIs across offline/quality/latency/license. The honest pitch: voice quality alone isn't a reason to switch off Piper, but the resident daemon plus bash helper for sub-15ms shell-side speech is the differentiator for shell-driven workflows. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
StuBehan
force-pushed
the
docs/readme-demo-and-comparison
branch
from
d11b291 to
b4b98d3
Compare
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
Two visibility wins for the public face of the repo, no code changes.
Changes
`docs/demo.wav` — 5 second voice sample at the top of the README
Generated locally with `Stackvox.synthesize()` using the cached Kokoro model: `af_heart` saying "Hello from stackvox." then `bf_emma` saying "Offline, Apache two-point-zero, CPU real-time." Concatenated with a 350ms gap. 234 KB as 24 kHz PCM_16 — small enough to commit and serve from the repo via GitHub's raw URL. Linked under the tagline so first-time visitors can hear what they'd be installing without doing anything.
If you'd rather replace it with something else (different voices, longer, your own recording), drop in a new `docs/demo.wav` — the README link uses a relative path.
README "How does this compare to other TTS?" section
Honest comparison table covering offline support, voice quality, latency, license, and best-for one-liner across:
Helps prospective users decide quickly whether stackvox is what they want — and explicitly calls out that voice quality alone isn't a reason to switch off Piper, but the resident daemon + bash helper for sub-15ms shell-side speech is the actual differentiator. Sets honest expectations.
Test plan