From 5380bb7d55c11d9bf2b841e48c578024ffebf746 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rodolphe=20Br=C3=A9ard?= Date: Sun, 27 Oct 2024 19:44:45 +0100 Subject: [PATCH] Add a howto section --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index cf38213..3e82d1a 100644 --- a/README.md +++ b/README.md @@ -49,3 +49,13 @@ gathering data on how it actually went in a real situation is another. This project choses the later and therefore aims to implement several of those algorithms in Rust and benchmark them. Let the battle begin. + + +## How to use + +1. Install [Rust][rust] and [gnuplot][gnuplot]. +2. Run `cargo bench`. +3. Look at the results in `./target/criterion/report/`. + +[rust]: https://www.rust-lang.org/ +[gnuplot]: http://www.gnuplot.info/