vmario
/
fabaccess-bffh
mirror of https://gitlab.com/fabinfra/fabaccess/bffh.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

INSTALL docs on running the bin

This commit is contained in:
Nadja Reitzenstein 2022-05-31 13:08:14 +02:00
parent e7828cd7f5
commit 84a4e9791e
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
INSTALL.md
View File

@ -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`.