hq/Noteguard
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

readme: update test instructions, add static build instructions

Browse source 
Signed-off-by: William Casarin <jb55@jb55.com>
This commit is contained in:
William Casarin 2024-07-09 10:35:02 -07:00
parent e28454ac32
commit 39d70fd179
1 changed files with 15 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -72,9 +72,21 @@ There are no config options, but an empty config entry is still needed:
You can test your filters like so:
```sh
$ cargo build --release
$ ./target/release/noteguard
$ <test/test-inputs ./target/release/noteguard
$ cargo build
$ <test/inputs ./target/debug/noteguard
$ ./test/delay | ./target/debug/noteguard
```
## Static builds
Static musl builds are convenient ways to package noteguard for deployment. It enables you to copy the binary directly to your server, assuming its the same architecture as the one you're building on.
```sh
$ rustup target add x86_64-unknown-linux-musl
$ cargo build --target x86_64-unknown-linux-musl --release
$ ldd ./target/x86_64-unknown-linux-musl/release/noteguard
statically linked
$ scp ./target/x86_64-unknown-linux-musl/release/noteguard server:
```
[strfry]: https://github.com/hoytech/strfry