commit 8b0873bc61b3251303d55a9d21957221b8b617b8
parent 682d283e91c2c142205d9eda4e7f33597fad08aa
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Tue, 12 Apr 2016 16:24:02 +0200
Rewrite the README file
Remove the reference to Star-Box since Star-4V/S is now a standalone
application.
Diffstat:
| M | README.md | | | 36 | ++++++++++++++++-------------------- |
1 file changed, 16 insertions(+), 20 deletions(-)
diff --git a/README.md b/README.md
@@ -1,26 +1,22 @@
-# Star Box 4V/S
-This library is a [Star-Box](https://gitlab.com/meso-star/star-box/) plugin
-that statistically solves "An invariant property of diffuse random walks" (S.
-Blanco and R. Fournier - Europhysics Letter 2003) on a set of models managed by
-the SBox application. This plugin assumes that the active SBox shapes define
-closed volumes and that their normals point into the volume. In, addition, the
-shapes are considered as fully emissive and the diffuse property of their
-volume is constant.
-
-Once loaded in SBox with the `import plugin` command, this plugin provides a
-new `4v_s` command to the SBox interpreter. Type `help 4v_s` for
-informations on this command.
+# Star-4V/S
+This program uses Monte-Carlo to statistically computes "An invariant property
+of diffuse random walks" (S. Blanco and R. Fournier - Europhysics Letter 2003)
+on an user defined geometry. The submitted geometry must define a set of
+polygonal meshes saved with respect to the Alias Wavefront Obj fileformat. The
+resulting surfaces must define a set of closed volumes whose normals point
+inward the volumes. The program assumes that the shape surfaces are fully
+emissive and the diffuse property of their volume is constant.
## How to build
-The library relies on [CMake](http://www.cmake.org) and the
+Star-4V/S relies on [CMake](http://www.cmake.org) and the
[RCMake](https://gitlab.com/vaplv/rcmake/#tab-readme) package to build. It also
-depends on
+depends on the
[RSys](https://gitlab.com/vaplv/rsys/),
[Star-3D](https://gitlab.com/meso-star/star-3d/),
-[Star-MC](https://gitlab.com/meso-star/star-mc/),
-[Star-SP](https://gitlab.com/meso-star/star-sp/) libraries and the
-[Star-Box](https://gitlab.com/meso-star/star-box/) software development kit.
+[Star-3DAW](https://gitlab.com/meso-star/star-3daw/),
+[Star-MC](https://gitlab.com/meso-star/star-mc/) and the
+[Star-SP](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 all the aforementioned prerequisites. Then generate the
@@ -30,8 +26,8 @@ the ones of its dependencies.
## License
-*Star Box 4V/S* is Copyright (C) |Meso|Star> 2015-2016 (<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;
+Star-4V/S is Copyright (C) |Meso|Star> 2015-2016 (<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.
