From a03c8c4d8dec58f87adbd6aeb629e1a0e392bc61 Mon Sep 17 00:00:00 2001 From: Dandaedre Date: Fri, 16 Oct 2026 21:13:17 +0200 Subject: [PATCH] docs: recommend prebuilt release installation in README Lead quick start with cargo-binstall for the published RC, manual downloads, runtime requirements and first-run setup. Retain source builds as an alternative. Validation: cargo-binstall --git with exact RC version and crate-meta-data strategy passed in dry-run mode, resolving all three published executables without installing. Local documentation links and git diff --check passed. No release or tag changes. --- README.md | 40 +++++++++++++++++++++++++++++++++++----- 1 file changed, 35 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e9c08bb..7709c68 100644 --- a/README.md +++ b/README.md @@ -42,21 +42,51 @@ cards, including one-row Slim and Bordered slim faders: ## Quick start -Install the platform dependencies described in the -[documentation index](docs/README.md), then run the combined server and TUI -with the sample PipeWire/Pulse profile: +### Install a prebuilt release (recommended) + +With [cargo-binstall](https://github.com/cargo-bins/cargo-binstall#installation) +installed, download the current release candidate without compiling: ```sh -cargo run --locked -p fader_master -- \ - --config examples/profiles/arch-pipewire.toml --audio pulse +cargo binstall --git https://proxy.dandaedre.com/gitea/MadGobblins/fader_master \ + --version '=0.1.0-rc.1' --strategies crate-meta-data fader_master +fader_master ``` +This installs the combined launcher plus `fader_master_server` and +`fader_master_client`. Ensure Cargo's binary directory (usually `~/.cargo/bin`) +is on your `PATH`. No repository checkout or sample configuration is needed. + +Prebuilt binaries currently target **x86-64 GNU/Linux** and require ALSA, +libpulse and libudev runtime libraries, plus PulseAudio or `pipewire-pulse`. +They are built with an Ubuntu 24.04-based image; older distributions are not +yet qualified. This is an RC, not a stable release. + +Without cargo-binstall, download the archive containing all three executables +from the [release page](https://proxy.dandaedre.com/gitea/MadGobblins/fader_master/releases/tag/v0.1.0-rc.1), +verify it against the accompanying `SHA256SUMS`, and extract the executables +into a directory on your `PATH`. + +### First launch + The combined executable connects to an existing per-user server when possible and starts an embedded one otherwise. Running without `--config` creates a `default` profile with a Master-output fader. A sole detected MIDI input is adopted as the default controller; otherwise choose a detected input in Config, add it, and Save. Edit the Master fader with `E` to learn volume and mute controls. +### Build from source (alternative) + +For development or systems without compatible prebuilt binaries, follow the +[build prerequisites](docs/build.md). From a source checkout, run: + +```sh +cargo run --locked -p fader_master +``` + +See [advanced configuration](docs/configuration.md) for explicit profiles and +separate server/client operation. + The screenshots use reproducible example state rendered by the actual TUI; they do not represent a live hardware session.