fader_master/docs
Dandaedre e11e537e12
docs: document M13 media controls and add a validated QBZ profile
Verify: cargo test -p fader-config --quiet: 60 tests passed, including round-trip validation of all 14 example controls; git diff --check passed; documented UI keys and limits reviewed against implementation. Hardware checklist explicitly remains opt-in and unverified.
2026-10-18 23:06:58 +02:00
..
images docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
README.md docs: document M13 media controls and add a validated QBZ profile 2026-10-18 23:06:58 +02:00
build.md docs: document M13 media controls and add a validated QBZ profile 2026-10-18 23:06:58 +02:00
ci-coverage.md docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
configuration.md docs: document M13 media controls and add a validated QBZ profile 2026-10-18 23:06:58 +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 feat: add bounded M13.3b MPRIS worker and native adapter 2026-10-18 22:49:03 +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.