commit 39d70fd179dfb2e539e19801d10f468187691b47 parent e28454ac32042a7ca60a4f2c3dbf8e0d65154a0c Author: William Casarin <jb55@jb55.com> Date: Tue, 9 Jul 2024 10:35:02 -0700 readme: update test instructions, add static build instructions Signed-off-by: William Casarin <jb55@jb55.com> Diffstat:
| M | README.md | | | 18 | +++++++++++++++--- |
1 file changed, 15 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md @@ -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