From 52a244da19ce4d041cb4b01a880652b3cee083bf Mon Sep 17 00:00:00 2001 From: Stan Grams Date: Sun, 29 Mar 2026 14:11:37 +0200 Subject: [PATCH] [docs](trx-rs): add trx-configurator step to README quick start Show the interactive setup wizard as the primary way to generate trx-server.toml and trx-client.toml, with --print-config as an alternative. Co-Authored-By: Claude Opus 4.6 (1M context) Signed-off-by: Stan Grams --- README.md | 35 +++++++++++++++++++++++++++++------ 1 file changed, 29 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 947a104..e9d4afe 100644 --- a/README.md +++ b/README.md @@ -67,19 +67,42 @@ brew install soapysdr See [Build Requirements](https://github.com/sgrams/trx-rs/wiki/User-Manual#build-requirements) in the wiki for details on each library. -### 2. Build and run +### 2. Build ```bash cargo build --release -cp trx-rs.toml.example trx-rs.toml # edit for your environment -cargo run -p trx-server -cargo run -p trx-client +``` + +Build without SDR support: `cargo build --release --no-default-features` + +### 3. Configure + +Run the interactive setup wizard to generate config files for your station: + +```bash +./target/release/trx-configurator +``` + +The wizard walks you through rig selection, serial port detection, audio +settings, and frontend options, then writes `trx-server.toml` and +`trx-client.toml`. + +Alternatively, generate example configs and edit them by hand: + +```bash +./target/release/trx-server --print-config > trx-server.toml +./target/release/trx-client --print-config > trx-client.toml +``` + +### 4. Run + +```bash +./target/release/trx-server --config trx-server.toml +./target/release/trx-client --config trx-client.toml ``` Open the configured HTTP frontend address in a browser (default `http://localhost:8080`). -Build without SDR support: `cargo build --release --no-default-features` - ## How It Works ```mermaid