Skip to content

docs: rewrite README for discoverability#64

Merged
timini merged 1 commit intomainfrom
docs/rewrite-readme-for-discoverability
Feb 27, 2026
Merged

docs: rewrite README for discoverability#64
timini merged 1 commit intomainfrom
docs/rewrite-readme-for-discoverability

Conversation

@timini
Copy link
Owner

@timini timini commented Feb 27, 2026

Summary

  • Restructure README into a clear narrative: hook → features → how it works → get started → go deeper
  • Replace ASCII pipeline diagram with 3 Mermaid flowcharts (pipeline flow, package architecture, frequency parallelization)
  • Add tagline, CI/Python badges, "What is this?" intro, and key features bullet list
  • New "Operating modes" section with single/auto/fullauto subsections and example commands
  • Wrap parameter tables in collapsible <details> blocks to reduce visual clutter
  • Preserve full acoustic modelling section (moved below getting started)
  • Add Contributing and License footer

Test plan

🤖 Generated with Claude Code

Restructure into hook → features → how it works → get started → go deeper.
Replace ASCII pipeline diagram with 3 Mermaid flowcharts (GitHub renders
natively). Add tagline, badges, key features list, operating modes section.
Wrap parameter tables in collapsible <details> blocks. Preserve the full
acoustic modelling section but move it below getting started.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@timini timini merged commit 7b5c758 into main Feb 27, 2026
13 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