commit 1569319d3c1cd3d61a4ff27d1f4560d1d1c2f32a parent 8b756ea13c5aa0acfed72a7b730e820fb7afbe10 Author: Christophe Coustet <christophe.coustet@meso-star.com> Date: Thu, 30 Apr 2020 15:10:14 +0200 Fix Readme Diffstat:
| M | README.md | | | 24 | ++++++++++++++++++------ |
1 file changed, 18 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md @@ -1,18 +1,30 @@ -#sgreen : stardis post-process +# sgreen + +## Overview sgreen is a postprocess of Green function binary files, as produced by the *stardis* program (https://gitlab.com/meso-star/stardis). The main purpose of sgreen is to compute Monte-Carlo results by applying Green functions to new settings, enabling ultra-fast Monte-Carlo computations. -Pour compiler il suffit de taper `make` après avoir préalablement renseigner -dans le makefile la variable SDIS_SDK qui est le chemin du SDK de Stardis. Voir -les notes de version en ci-dessous pour avoir la bonne version du SDK. +## How to build + +Stardis relies on the [CMake](http://www.cmake.org) and the +[RCMake](https://gitlab.com/vaplv/rcmake/) package to build. +It also depends on the +[RSys](https://gitlab.com/vaplv/rsys/) library as well as on the +[OpenMP](http://www.openmp.org) 2.0 specification to parallelize its +computations. +First ensure that CMake and a C compiler that implements the OpenMP 2.0 +specification are installed on your system. Then install the RCMake package as +well as all the aforementioned prerequisites. Finally generate the project from +the `cmake/CMakeLists.txt` file by appending to the `CMAKE_PREFIX_PATH` +variable the install directories of its dependencies. -# Release Notes +## Release notes -## v0.1 +### Version 0.1 Postprocess a binary Green function file, as created by stardis. Main features are: