diff --git a/README.md b/README.md index 127377ed2520ebb7b90179df39d2c74b9d05eadc..b47b3ac90a3815b7ba34de67c0dfd722de9d4b99 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,36 @@ # cell_algorithms ```bash +# clone repo +git clone git@github.com:eth-cscs/cell_algorithms.git +cd cell_algorithms/ + +# setup sub modules git submodule init git submodule update + +# setup environment +module load gcc +module load cmake +export CC=`which gcc` +export CXX=`which g++` + +# build modparser +cd modparser +cmake . +make -j +cd .. + +# create mechanisms +cd mechanisms +./generate.sh +cd .. + +# build main project +cmake . +make -j + +# test +cd tests +./test.exe ```