fader_master/docs/build.md

1.4 KiB

Build prerequisites

fader_master targets Linux and uses Rust 2024. Rust 1.88.0 is the selected minimum supported Rust version (MSRV) and the repository-pinned development toolchain. rustup reads rust-toolchain.toml and installs the required rustfmt, Clippy, and LLVM tools components.

The current scaffold needs a C compiler and linker for transitive Rust system crates, but it does not yet link to an audio daemon or MIDI library. On a Debian-family Linux system, the foundation prerequisites are:

sudo apt-get install build-essential pkg-config
rustup toolchain install 1.88.0 \
    --profile minimal \
    --component rustfmt \
    --component clippy \
    --component llvm-tools-preview

Future PulseAudio, PipeWire, ALSA, MIDI, and udev adapters will add native development packages. Their exact package names and feature-specific build commands must be documented when those adapters are introduced; the scaffold does not claim those dependencies yet.

From a fresh checkout, use the tracked lockfile for reproducible resolution:

cargo build --workspace --locked
cargo test --workspace --all-targets --all-features --locked

Verify the MSRV explicitly without allowing rust-toolchain.toml to select a newer installed toolchain:

cargo +1.88.0 check --workspace --all-targets --all-features --locked
cargo +1.88.0 test --workspace --all-targets --all-features --locked