commit e9b942f047442827e033286e1d800017079aee04
parent 9372435cb9d911be561dfcf544b89ebe3d32b84f
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Mon, 17 Jul 2023 16:33:43 +0200
Rewrite the README file
Cleanup and small rewrite of the preview. Add a requirements section
that lists the dependencies of the project. Complete rewrite of the
installation procedure regarding the use of POSIX make and no longer
CMake.
Diffstat:
| M | README.md | | | 32 | +++++++++++++++----------------- |
1 file changed, 15 insertions(+), 17 deletions(-)
diff --git a/README.md b/README.md
@@ -1,24 +1,21 @@
# Star Monte Carlo
-The purpose of this C library is to manage the statistical estimation of a
-function.
+Star-MonteCarlo tries to simplify the calculation of the estimate of a
+user-defined integrator. It ensures the idenpendance of random sequences
+between threads and automates the calculation of expectation, variance and
+standard error.
+
+## Requirements to build
+
+C compiler, POSIX make, pkg-config, and the header files and libraries of
+[RSys](https://gitlab.com/vaplv/rsys) and
+[Star-SP](https://gitlab.com/meso-star/star-sp).
## How to build
-The Star-MC library 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/) and the
-[Star-Sampling](https://gitlab.com/meso-star/star-sp/) libraries.
-
-First ensure that CMake is installed on your system. Then install the RCMake
-package as well as the RSys and the Star-Sampling libraries. Finally generate
-the project from the `cmake/CMakeLists.txt` file by appending to the
-`CMAKE_PREFIX_PATH` variable the `<RCMAKE_INSTALL_DIR>`, `<RSYS_INSTALL_DIR>`
-and `<SSP_INSTALL_DIR>` directories, where `<RCMAKE_INSTALL_DIR>`,
-`<RSYS_INSTALL_DIR>` and `<SSP_INSTALL_DIR>` are the install directories of the
-RCMake package, the RSys and the Star-Sampling libraries, respectively. The
-generated project can be edited, built, tested and installed as any CMake
-project.
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
@@ -46,7 +43,8 @@ highers fix compilation errors with gcc 11 but introduces API breaks: the
## License
-Copyright (C) 2015-2018, 2021, 2022 |Meso|Star> (<contact@meso-star.com>).
+Copyright (C) 2015-2018, 2021, 2022 |Meso|Star> (contact@meso-star.com)
+
Star-MC is free software released under the CeCILLv2.1 license. You are welcome
to redistribute it under certain conditions; refer to the COPYING files for
details.
