From 84a4e9791e16b7a040f88d152b4ff20d20d1f39e Mon Sep 17 00:00:00 2001 From: Nadja Reitzenstein Date: Tue, 31 May 2022 13:08:14 +0200 Subject: [PATCH] INSTALL docs on running the bin --- INSTALL.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/INSTALL.md b/INSTALL.md index bab36ef..3b667d0 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -32,7 +32,7 @@ Diflouroborane uses Cargo, so compilation boils down to: $ cargo build --release ``` -The compiled binary can then be found in `./target/release/diflouroborane` +The compiled binary can then be found in `./target/release/bffhd` ### Cross-compiling @@ -40,3 +40,14 @@ If you need to compile for a different CPU target than your own (e.g. you want to use BFFH on a raspberry pi but compile on your desktop PC), you need to setup a cross-compilation toolchain and configure your Cargo correctly. [The `CONTRIBUTING.md` has a section on how to setup a cross-compilation system.](CONTRIBUTING.md#cross-compilation) + +# Running bffhd + +The server can be ran either using `cargo`, which will also compile the binary if necessary, or directly. + +When running using `cargo` you need to pass arguments to bffh after a `--`, so +e.g. `cargo run --release -- --help` or `cargo run --release -- -c examples/bffh.toml`. + +When running directly the `bffhd` binary can be copied anywhere. + +A list of arguments for the server is found in the help, so `bffhd --help` or `cargo run --release -- --help`.