commit 0bc2510d769fb73e11fd5e83e1ed174719e41415
parent bd7cec442b5a7506ab1d0a9f45b01c91e87e2ef6
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Sun, 4 Jun 2023 10:21:45 +0200
Réécriture du fichier README
Le fichier README rend désormais compte de la procédure de génération
automatique basée sur un Makefile POSIX et de l'utilisation de noweb
pour écrire l'algorithme Monte Carlo
Diffstat:
| M | README.md | | | 66 | +++++++++++++++++++++++++++++++++++++++--------------------------- |
1 file changed, 39 insertions(+), 27 deletions(-)
diff --git a/README.md b/README.md
@@ -1,38 +1,50 @@
# Star Geometric Sensitivity
-This program tests the estimation of geometric sensitivities in a set of
-predefined scenes.
+Example of geometric sensitivity calculation. The entire program is written in
+plain ANSI C, with the exception of the Monte Carlo solver, which is written in
+noweb using French as the literate language and in the comments, to make the
+source code easier to read for French-speaking readers.
-## How to build
+## Requirements
-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.
+In order to build the `sgs` program, you need the RSys Star-3D, Star-MC and
+Star-SamPling headers and libraries as well as the noweb literate programming
+tool.
-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.
+## Build
+
+Build the `sgs` program:
+
+ make
+
+Generate the pdf of the noweb sources:
+
+ make pdf
+
+Note that the pdf contains graphics generated from the `results.fd` file, which
+is a results file generated by the `sgs` program. Calculating these results
+can be time-consuming, which is why this file is not re-generated every time
+the sources are updated, even though it should be. Instead, pre-calculated
+results are supplied with the sources, allowing you to generate the pdf without
+running `sgs`. You can, however, force the generation of results by executing
+the following command:
+
+ make results.fd
## Copyright notice
-Copyright (C) 2021-2023 Centre National de la Recherche Scientifique
-Copyright (C) 2021-2023 INSA Lyon
-Copyright (C) 2021-2023 Institut Mines Télécom Albi-Carmaux
-Copyright (C) 2021-2023 [|Méso|Star>](https://www.meso-star.com) (<contact@meso-star.com>)
-Copyright (C) 2021-2023 Institut Pascal
-Copyright (C) 2021-2023 [PhotonLyX](http://www.photonlyx.com/) (<info@photonlyx.com>)
-Copyright (C) 2021-2023 Université de Lorraine
-Copyright (C) 2021-2023 Université Paul Sabatier
-Copyright (C) 2021-2023 Université Toulouse - Jean Jaurès
+Copyright © 2021-2023 Centre National de la Recherche Scientifique
+Copyright © 2021-2023 INSA Lyon
+Copyright © 2021-2023 Institut Mines Télécom Albi-Carmaux
+Copyright © 2021-2023 |Méso|Star> (contact@meso-star.com)
+Copyright © 2021-2023 Institut Pascal
+Copyright © 2021-2023 PhotonLyX (info@photonlyx.com)
+Copyright © 2021-2023 Université de Lorraine
+Copyright © 2021-2023 Université Paul Sabatier
+Copyright © 2021-2023 Université Toulouse - Jean Jaurès
## 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.
+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.
