diff --git a/README.md b/README.md index e69de29..9400855 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,16 @@ +# Pivot-SAW + +**Pivot** **s**elf **a**voiding **w**alk + +## How to run it + +### Visualization + +The visualization can be run using the command `cargo run --release` in the directory `crates/visualization`. + +### Analysis + +You can run the analysis by executing the following two commands in the directory `crates/analysis`: + +- `cargo run --release` which generates `analysis.csv` +- `julia --project main.jl` which generates `analysis.png`