fader_master/docs
Dandaedre 8ac222b501
Rust CI fader_master passed its selected CI mode.
MadGobblins/fader_master/pipeline/head This commit looks good Details
release: prepare v0.1.0-rc.2
Bump all workspace packages and lockfile together, update installation and release references, and record RC2 changes and remaining prerelease limitations.

Validation: cargo fmt --all -- --check; workspace all-target/all-feature check, strict Clippy, doctests and release build; workspace all/default/no-default test matrices and independent midi/midir and volume_lib/pulse tests all pass on Rust 1.88.0. Two hardware tests remain opt-in. python3 scripts/test-release.py: 8 passed; sh -n release.sh passes. ShellCheck unavailable. Fixed publisher ed2ce6e dry run validates metadata and prerequisites except for the RC2 tag, to be created after this commit.
2026-10-18 13:58:34 +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 fix: default mute feedback to the same note on all devices 2026-10-18 13:50:46 +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 release: prepare v0.1.0-rc.2 2026-10-18 13:58:34 +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.