fader_master/docs
Dandaedre 2b725ca82f
feat: fold MIDI unbind into the learn prompt
M9.5: Remove separate Unlearn rows. U in a locally opened Learn MIDI prompt cancels capture and removes only that fader action; Esc cancels unchanged. Retain the controller for relearning and document the compact workflow.

Tests: updated guided-editor regression fails before implementation; new volume/mute scope, cancel and relearn regression passes. cargo fmt --all -- --check, cargo check --workspace --all-targets --all-features, cargo test --workspace --all-targets --all-features --quiet (48 TUI tests, two opt-in hardware tests ignored), cargo test --workspace --doc --all-features, cargo clippy --workspace --all-targets --all-features -- -D warnings, and cargo build --workspace --release --all-features all pass.
2026-10-18 21:52:07 +02:00
..
images docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
README.md build(M12.4): prepare guarded Gitea release wrapper 2026-10-16 19:59:16 +02:00
build.md docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
ci-coverage.md docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
configuration.md feat: fold MIDI unbind into the learn prompt 2026-10-18 21:52:07 +02:00
midi-identity.md docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
pulse-daemon-fixture.md docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
related-projects.md docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
releasing.md docs: record verified RC2 publication 2026-10-18 14:01:27 +02:00

README.md

Documentation

Use and configuration

For everyday layout editing: select a fader or separator and press E. Separators accept empty names, independent size and decoration, and Fill space. Config contains theme/orientation/pickup display, hidden-fader restoration, profile switching, MIDI devices, and Save. See the mixer presentation reference.

Design and development

Ecosystem

Screenshot maintenance

Both README screenshots are deterministic renders of the real TUI using example state, not captures of a live audio session:

  • Horizontal mixer: five side-by-side faders, a double divider, an unnamed Fill spacer, mute and group-mixed state.
  • Vertical mixer: section labels, Standard, Slim and Bordered slim rows, and the default output.

Regenerate all screenshots after presentation changes:

cargo run --locked -p tui --example doc_screenshots

The generator lives in doc_screenshots.rs. It places text on the terminal cell grid and draws box/block glyphs to cell edges so font differences do not break borders or meters. Inspect both SVGs in a browser or rasterize with rsvg-convert for review; confirm every fader, label and keyboard hint is visible. Do not hand-edit the generated SVG files.