From cc1808ee3c50e907c566715b740b0f95a6d9414c Mon Sep 17 00:00:00 2001
From: smail alijagic <smailongithub@gmail.com>
Date: Mon, 27 Apr 2026 12:54:05 +0200
Subject: [PATCH] added a REAME.md

---
 README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f3bb0d1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# Advanced Systems Lab - Spring 2026
+This is the GitLab repository of group 70.
+Project topic: Social Force Model for Pedestrian Dynamics
+
+The goal of this project was to implement a fast version of Helbing's social force model. The final report includes an analysis and results of the work.
+
+This repository contains all C++ and Python code that was used to generate and analyze the data.
+
+
+## Compilation
+Linux
+
+``
+
+Windows
+
+``
+
+Apple
+
+`clang++ -O3 -march=native -o main_test_visualisation main.cpp forces.cpp`
+
+Compile the code with running the bash script 'src/main/run_simulation.sh'. After compilation was succesfull the user has 3 different option:
+1. Benchmark
+2. Test
+3. Visualization
+
+The flags used are:
+`gcc -lm -O3 -mavx2 -mfma -ffast-math -g`
+
+## Storing coordinates in a csv
+`./main_test_visualisation <number of pedestrians> <number of iterations> <csv file>`
+
+
+## Visualization
+`python3 visualization.py <csv file> <mp4 file>`
+
+
+## Benchmark
+
+
+
+## Test
+