From b551c3f4be791b9145720c83d3c958fa8834d78d Mon Sep 17 00:00:00 2001 From: Marvin Vogt Date: Sun, 6 Oct 2024 18:12:24 +0000 Subject: [PATCH] Update benchmark README --- docs/benchmark/README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/benchmark/README.md b/docs/benchmark/README.md index b2c2c3e..48b54da 100644 --- a/docs/benchmark/README.md +++ b/docs/benchmark/README.md @@ -23,8 +23,7 @@ With the exception of [RIPE-NCC/whois], the AS3257 object is included as a strin ## Running Benchmarks Benchmarks for the parser itself are done using `cargo bench`, while any external parser is benchmarked using [hyperfine].\ -To run specific benchmarks, execute `/.run` in the directory of the respective parser. -It sets up dependencies and runs `sudo` so it is only recommended to be used in an isolated environment and is only tested using the devcontainer, other platforms might require additional dependencies to be installed. +To run a specific benchmark execute `just bench-$PARSER-NAME` or `just benchmark-comparison` to run all benchmarks. This will setup required dependencies and run `sudo` so it is only recommended to be used in an isolated environment and is only tested using the devcontainer, other platforms might require additional dependencies to be installed. A working installation of `just` and `cargo` is assumed. [RPSL::Parser]: https://metacpan.org/pod/RPSL::Parser [irrdnet/irrd]: https://github.com/irrdnet/irrd