From 6598133899bcc36969311cc232e39cf66071cb43 Mon Sep 17 00:00:00 2001
From: Arec Jamgochian <jamgochian95@gmail.com>
Date: Fri, 2 Jul 2021 14:18:06 +0200
Subject: [PATCH] Update README.md

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

diff --git a/README.md b/README.md
index ce62e69..35e6635 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,21 @@
 # InteractionImitation
 Imitation Learning with the INTERACTION Dataset
+
+## Getting started
+Clone InteractionSimulator and pip install the module.
+```
+git clone https://github.com/sisl/InteractionSimulator.git
+cd InteractionSimulator
+git checkout v0.0.1
+pip install -e .
+cd ..
+export PYTHONPATH=$(pwd):$PYTHONPATH
+```
+Install additional requirements
+```
+pip install -r requirements.txt
+```
+Copy INTERACTION Dataset files:
+The INTERACTION dataset contains a two folders which should be copied into a folder called `./InteractionSimulator/datasets`: 
+  - the contents of `recorded_trackfiles` should be copied to `./InteractionSimulator/datasets/trackfiles`
+  - the contents of `maps` should be copied to `./InteractionSimulator/datasets/maps`