Skip to content

docs(readme): reflect the three TTS engines, local synthesis, silero-native - #170

Merged
xilec merged 1 commit into
mainfrom
xilec/readme_update
Aug 1, 2026
Merged

docs(readme): reflect the three TTS engines, local synthesis, silero-native#170
xilec merged 1 commit into
mainfrom
xilec/readme_update

Conversation

@xilec

@xilec xilec commented Aug 1, 2026

Copy link
Copy Markdown
Owner

Summary

The README still described the pre-#166 engine lineup (Piper + optional Python Silero) and never mentioned a key product property — that narration is fully local. This brings both language versions up to date:

  • Three TTS engines: Piper (default), native Silero v5 on ONNX Runtime (silero-native crate, ~230 MB bundle downloaded on demand), Python ttsd sidecar (fallback)
  • Explicit note: all synthesis runs locally, no cloud TTS; network is used only for one-off voice model downloads (verified: no updater/telemetry in the app)
  • Slim build .#ruvox now ships Piper + native Silero; full .#ruvox-with-silero only adds the ttsd sidecar
  • Test commands include the silero-native crate; docs table links it

Docs-only change — no OpenSpec, no behavior impact.

…native

- Intro + stack table: Piper (default), native Silero v5 on ONNX
  Runtime (silero-native crate, bundle on demand), Python ttsd sidecar
  (fallback)
- State explicitly that all synthesis runs locally; the network is
  only used for one-off voice model downloads
- Production build: slim now ships Piper + native Silero; full adds
  only the ttsd sidecar
- Tests: add the silero-native cargo test command
- Docs table: link the silero-native crate docs
- Mirror all changes in README.ru.md
@xilec
xilec merged commit 0cf5799 into main Aug 1, 2026
6 checks passed
@xilec
xilec deleted the xilec/readme_update branch August 1, 2026 10:23
xilec added a commit that referenced this pull request Aug 1, 2026
## Summary

Follow-up to #170 — the README was updated to the three-engine lineup,
but the same stale "Piper + optional Python Silero" description remained
in other docs:

- `docs/index.md` — intro and stack table now list all three engines;
removed dead links to `RewriteNotes.md` / `RewriteTaskPlan.md` /
`task_history.md` (files no longer exist); spec list synced with the
actual `openspec/specs/` contents
- `AGENTS.md` — overview lists Piper (default), `silero-native`
(in-process ONNX Runtime), `ttsd` (fallback); slim/full build
description corrected
- `ai/rules/conventions.md` — engine roles updated
- `docs/development.md` — `tts/` covers all engines, `silero-native/`
added to the layout tree, slim build no longer described as linking
`ttsd`
- `docs/install.md` — Python section is explicitly only for the `ttsd`
engine
- `justfile` — slim/full build comments

Docs-only change.
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