From eeac2f9ce94e3e1086e7c87358a6bce7e3c20833 Mon Sep 17 00:00:00 2001
From: "armindamon.riess" <armindamon.riess@uzh.ch>
Date: Thu, 15 Dec 2022 15:11:38 +0100
Subject: [PATCH] description and instructions

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

diff --git a/README.md b/README.md
index d5d2d62..08749cf 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,19 @@
 # N Body Simulation
 
+This code simulates particles under self-gravity. The forces are calculated via direct summation or with a tree and multipole expansion. 
+Most of the code is written in C++, Python is used to make plots and animations. OpenMP is used for parallelisation. 
 
+## Make build directory
 
+'''
+nbody$ mkdir build
+nbody$ cd build
+nbody/build$ cmake ..
+'''
 
-## Create Repository 
+## Compiling and running the simulation
 
-```
-git init
-git remote add origin git@gitlab.uzh.ch:armindamon.riess/nbody.git
-git pull --set-upstream origin master
-```
\ No newline at end of file
+'''
+nbody/build$ make
+nbody/build$ ./nbody
+'''
\ No newline at end of file
-- 
GitLab