Add README
This commit is contained in:
parent
eed9e189b2
commit
57ad819015
1 changed files with 16 additions and 0 deletions
16
README.md
16
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`
|
Reference in a new issue