diff --git a/README.md b/README.md index d5d2d62c1e9c7c62f9f4d06b1495ec83ac5c1ae0..08749cfab488670e35faf1b136ca08c89cf7a3f9 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