fader_master/docs/README.md

57 lines
2.4 KiB
Markdown

# Documentation
## Use and configuration
- [Build prerequisites](build.md) — Linux packages, Rust toolchain, feature
combinations, and the current FreeBSD CI mode.
- [Advanced configuration](configuration.md) — process layouts, managed
profiles, TOML concepts, migration, validation, and operational commands.
- [Example PipeWire/APC MINI profile](../examples/profiles/arch-pipewire.toml)
- [Example desktop profile](../examples/profiles/desktop.toml)
- [MPRIS controls and editing](configuration.md#media-controls-mpris)
- [Example QBZ media profile](../examples/profiles/media-qbz.toml)
- [Hands-on functional checklist](../checklist.md)
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](configuration.md#mixer-presentation).
## Design and development
- [Architecture and library research](../architecture.md)
- [Implementation tasks and acceptance tests](../task.md)
- [Project-agent and commit workflow](../AGENTS.md)
- [MIDI identity design](midi-identity.md)
- [Pulse-compatible daemon fixture](pulse-daemon-fixture.md)
- [CI coverage and badge lifecycle](ci-coverage.md)
- [Release preparation and publication](releasing.md)
- [Changelog](../CHANGELOG.md)
## Ecosystem
- [Related projects and libraries](related-projects.md)
## Screenshot maintenance
Both README screenshots are deterministic renders of the real TUI using
example state, not captures of a live audio session:
- [Horizontal mixer](images/mixer-horizontal.svg): five side-by-side faders,
a double divider, an unnamed Fill spacer, mute and group-mixed state.
- [Vertical mixer](images/mixer-vertical.svg): section labels, Standard,
Slim and Bordered slim rows, and the default output.
Regenerate all screenshots after presentation changes:
```sh
cargo run --locked -p tui --example doc_screenshots
```
The generator lives in [doc_screenshots.rs](../tui/examples/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.