commit f56fc0b3211cc1d761f34fdf6d6c1347ecc281cb
parent 3e7fc40be8c1e9ac27a305cc02abb97dffb579c4
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 15 May 2015 17:27:20 +0200
Update the README file
Diffstat:
1 file changed, 15 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
@@ -6,22 +6,24 @@ function.
## 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/) library.
+[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 library. Finally generate the project from the
-`cmake/CMakeLists.txt` file by appending to the `CMAKE_PREFIX_PATH` variable
-the `<RCMAKE_INSTALL_DIR>/lib/cmake` and `<RSYS_INSTALL_DIR>` directories,
-where `<RCMAKE_INSTALL_DIR>`, and `<RSYS_INSTALL_DIR>` are the install
-directories of the RCMake package and the RSys library, respectively. The
-generated project can be edited, built, tested and installed as any CMake
-project.
+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>/lib/cmake`,
+`<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.
## License
-The *Star-MC* library is a free software released under the
-[OSI](http://opensource.org)-approved CeCILL license. You are welcome to
-redistribute it under certain conditions; refer to the COPYING files for
-details.
+*Star-MC* is Copyright (C) |Meso|Star> 2015 (<contact@meso-star.com>). It is a
+free software released under the [OSI](http://opensource.org)-approved CeCILL
+license. You are welcome to redistribute it under certain conditions; refer to
+the COPYING files for details.
