The bisque-voice README drops from 602 to 89 lines, with install and internals moved to their own files

1 hour ago

The readme for bisque voice just went from about 600 lines to about 90. The install steps became a new guide written for coding agents, and the internals moved into the contributing file. Here is where each piece went, and what to check when you review it.

Ask about this presentation

Chapters

  1. 0:00The change
  2. 0:16Quick start
  3. 0:33Where it went
  4. 0:49Written for an agent
  5. 1:10Six steps
  6. 1:27Checksum and signature
  7. 1:47Intel Macs
  8. 2:10One timing per word
  9. 2:33Pronunciation, packs, audio
  10. 2:58What to check
Show transcript
  1. The readme for bisque voice just went from about 600 lines to about 90. The install steps became a new guide written for coding agents, and the internals moved into the contributing file. Here is where each piece went, and what to check when you review it.

    Slide text
    bisque-voice · docs

    The README shrank from 602 lines to 89.

    The rest moved into an install guide for coding agents and a how-it-works section in CONTRIBUTING.md.

  2. Before, the readme ran about 600 lines. Now it runs about 90. What stays is the pitch, one command that turns text into speech, and the JSON that comes back with a start and end time for every word. Everything longer has a different home.

    Slide text
    README.md

    The README is now a quick start.

    602 lines
    89 lines

    One command, and the JSON it prints: words, durationMs, hash.

  3. Three files changed. Installing and setting up moved into a new file, about 250 lines. And the explanation of how the engine works moved into the contributing file, which grew by about 100 lines. The readme keeps the quick start.

    Slide text
    Three files

    Two other files took on the README's old jobs.

    README.md
    +52 −565 lines
    quick start
    INSTALL.md
    new · 252 lines
    setup, for an agent
    CONTRIBUTING.md
    +96 lines
    how it works inside
  4. The opening line of the install guide says it is written for a coding agent setting the tool up for a person. Each step gives the exact command and a check that tells the agent it worked. Two steps are decisions for the person, which voice model and which voice. The guide tells the agent to ask before installing anything large.

    Slide text
    INSTALL.md

    The install guide is written for a coding agent.

    “Each step has the exact command and a check that tells you it worked.”
    “Ask before you install anything large.”
  5. The guide has six steps, from installing the program to synthesizing a first clip. Steps two and three belong to the person, because they choose the model and the voice. Every step closes with a check. After installing a model, for example, the doctor command should list it as installed.

    Slide text
    INSTALL.md

    Each step ends with a check you can run.

    1 Install the program
    2 Install a voice model person decides
    3 Pick a voice person decides
    4 Clone the person’s voice
    5 Forced aligners
    6 Synthesize

    Check: bisque-voice doctor lists the model as installed.

  6. The old readme explained how to verify a download, and that explanation now lives in the install guide. The checksum shows that the file arrived intact. The signature shows who built it. Someone who could replace the archive could replace its checksum too, but they could not sign as the team that owns the binary.

    Slide text
    INSTALL.md · checking a download by hand

    A checksum proves the file arrived. A signature proves who built it.

    SHA-256
    file arrived intact
    shasum -a 256 -c …sha256
    Signature
    built by team UG9Z22779U
    codesign --verify --strict bisque-voice
  7. One platform gets special treatment. Kokoro and the forced aligners need ONNX Runtime, which no longer ships for Intel Macs, so that build keeps only the Qwen3 models. The engines command still lists Kokoro, with the reason it is unavailable. The contributing file adds a test command for that configuration, so the reduced build gets exercised.

    Slide text
    INSTALL.md · CONTRIBUTING.md

    Intel Macs build without Kokoro, so there is a test for that.

    ONNX Runtime no longer ships for Intel Macs. That build keeps Qwen3-TTS only.

    cargo test --no-default-features
  8. The new internals section opens with a promise. The words array always has one entry per word of the input, because callers index it to place cues. If the text gets expanded, so a dollar figure is spoken as four words, the time is spread across the word it came from, and exact is set to false. If the engine cannot line the words up, it fails instead.

    Slide text
    CONTRIBUTING.md · how it works inside

    One timing per word, or a failure.

    input word $4.2M
    spoken as four point two million dollars
    words entries 1 with exact: false
  9. Three more topics follow. For pronunciation, every language is a port of the Misaki pipeline, and the tests compare against its output character for character. Model packs are checked against a checksum before extraction, and extracted into a temporary folder that is renamed into place. And audio defaults to MP3, split at sentence boundaries because Kokoro accepts at most 510 tokens.

    Slide text
    CONTRIBUTING.md

    It also documents pronunciation, model packs and audio.

    Pronunciation
    tests match Misaki’s output character for character
    Model packs
    checked before extracting, renamed into place
    Audio
    MP3 by default, split at sentence ends
  10. This change touches three markdown files and no code, so the risk is a command or a link that no longer works. Run the check lines in the install guide, since an agent will follow them literally. And confirm the links still resolve, including the one to the voice curation page.

    Slide text
    Reviewing this

    Only documentation changed, so the commands are the thing to check.

    • Run each Check line in INSTALL.md
    • Confirm the links still resolve

What happened in AI today, in your inbox

One short email each evening. Read it and you’re caught up.

Built in New York with ❤️