fader_master/docs/build.md

45 lines
1.4 KiB
Markdown

# 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 default build includes the PulseAudio protocol adapter and links to
libpulse. On a Debian-family Linux system, install:
```sh
sudo apt-get install build-essential pkg-config libpulse-dev
rustup toolchain install 1.88.0 \
--profile minimal \
--component rustfmt \
--component clippy \
--component llvm-tools-preview
```
The Pulse adapter works with PulseAudio and PipeWire's pipewire-pulse
compatibility service. A build that deliberately excludes native audio
dependencies remains available:
```sh
cargo build --workspace --no-default-features --locked
```
Future native PipeWire, ALSA, MIDI, and udev adapters will add their own
feature-gated development packages.
From a fresh checkout, use the tracked lockfile for reproducible resolution:
```sh
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:
```sh
cargo +1.88.0 check --workspace --all-targets --all-features --locked
cargo +1.88.0 test --workspace --all-targets --all-features --locked
```