From 57ad819015a46762813d7b8ab4ebba6052ebdb23 Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Wed, 2 Aug 2023 18:59:49 +0200
Subject: [PATCH] Add README

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

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`