fader_master/docs
Dandaedre dc27b764fc
docs: plan M13 matching and media control stretch goals
Document the existing media.name YouTube regex as sufficient. Order AND selectors and process/Steam metadata before targeted MPRIS controls, with dependencies and acceptance criteria; distinguish planned schema from current RC2 behavior.

Validation: git diff --cached --check passed; reviewed selector example against current supported fields and OR semantics, and checked M13 references across configuration guide, architecture and backlog. Documentation only; runtime tests not required.
2026-10-18 21:48:54 +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 docs: plan M13 matching and media control stretch goals 2026-10-18 21:48:54 +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.