commit b9be358b4f40b29686f3af9324890df657232a01
parent 06ee9b617fc7b66235e57e9b666cc61171a5a90f
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 12 Jul 2023 11:40:41 +0200
Rewrite the README file
Small rewrite of the preview section. Make the description of the
requirements concise and completely rewrite the installation section
regarding the use of a POSIX Makefile and no longer CMake as the first
build system. Remove the section regarding Visual Studio since it is no
longer supported as a development environment.
Diffstat:
| M | README.md | | | 58 | ++++++++++++++++++++++------------------------------------ |
1 file changed, 22 insertions(+), 36 deletions(-)
diff --git a/README.md b/README.md
@@ -1,36 +1,22 @@
# Star SamPling
-The purpose of this library is to generate [pseudo] random numbers and
-distributions. While it is partly based on C++11 random generators, its API
-remains pure C.
-
-## How to build
-
-The Star-Sampling library relies on the [CMake](http://www.cmake.org) and the
-[RCMake](https://gitlab.com/vaplv/rcmake/) packages to build. It also depends
-on the [RSys](https://gitlab.com/vaplv/rsys/) library and on random number
-generators from C++11 and the
-[Random123](https://www.deshawresearch.com/resources_random123.html) library.
-
-First ensure that CMake and a C++11 compiler are installed on your system. Then
-install the RCMake package as well as the RSys and Random123 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 `<RANDOM123_INSTALL_DIR>` directories, where `<RCMAKE_INSTALL_DIR>`,
-`<RSYS_INSTALL_DIR>` and `<RANDOM123_INSTALL_DIR>` are the install directories
-of the RCMake package and the RSys and Random123 libraries, respectively.
-
-### Microsoft Visual Studio
-
-When building Star-Sampling using Visual Studio, the Star-Sampling library
-also depends on the [Boost](http://www.boost.org) random library as a
-replacement for the STL libray that is not fully compliant with the C++11
-standard on current Microsoft compilers.
-
-For this platform install the Boost random library. Then generate the CMake
-project as above, excepted that you need to add the Boost install directory to
-the `CMAKE_PREFIX_PATH` variable and to set the `BOOST_INCLUDEDIR` cmake
-variable to the directory that contains the `boost` include directory.
+Star-SamPling is a library whose purpose is to generate pseudo-random numbers
+and sample distributions. A proxy generator can also be used to generate
+independent random sequences from the same pseudo-random generator. This is
+particularly useful for ensuring the statistical independence of random
+sequences on parallel computations. Although Star-SamPling relies on C++
+libraries, its API is still raw C.
+
+## Requirements
+
+A C++11 compiler, POSIX Make, pkg-config, Random123 header files and RSys
+header files and library.
+
+## Installation
+
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
@@ -52,7 +38,6 @@ from the next one.
#### Issues in RNG proxy
-
- Fixes the `ssp_rng_proxy_read` function: cached RNG states were not being
cleaned up when updating the proxy state, resulting in the use of random
numbers generated from the wrong state.
@@ -166,8 +151,9 @@ CMake 3.20, version 2 has become obsolete.
## License
-Copyright (C) 2015-2022 |Meso|Star> (<contact@meso-star.com>). Star-Sampling 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.
+Copyright (C) 2015-2022 |Méso|Star> (contact@meso-star.com)
+
+Star-Sampling 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.
