commit 1a8529bb096a8c9f3e833caadb2c6ebb77dbf7d6
parent f802b31b2610867fb5bdfd060b2a51e4561047c8
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Sun, 18 Apr 2021 19:32:30 +0200
Add the README.md file
Diffstat:
| A | README.md | | | 34 | ++++++++++++++++++++++++++++++++++ |
1 file changed, 34 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,34 @@
+# Star Geometric Sensitivity
+
+This program tests the estimation of geometric sensitivities in a set of
+predefined scenes.
+
+## How to build
+
+The program is compatible GNU/Linux 64-bits. It relies on the
+[CMake](http://www.cmake.org) and the
+[RCMake](https://gitlab.com/vaplv/rcmake/) packages to build. It also depend on
+the [RSys](https://gitlab.com/vaplv/rsys/) and the
+[Star3D](https://gitlab.com/meso-star/star-3d/) libraries.
+
+To build it, first ensure that CMake is installed on your system. Then install
+the RCMake package as well as 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. The
+resulting project can be edited, built, tested and installed as any CMake
+project. Refer to the [CMake documentation](https://cmake.org/documentation)
+for further informations on CMake.
+
+## Copyright notice
+
+Copyright (C) 2021
+ CNRS/RAPSODEE,
+ CNRS/LMAP,
+ [|Meso|Star>](http://www.meso-star.com) <contact@meso-star.com>,
+ UPS/Laplace.
+
+## License
+
+Star Geometric Sensitivity is free software released under the GPL v3+
+license: GNU GPL version 3 or later. You are welcome to redistribute them under
+certain conditions; refer to the COPYING file for details.
