commit 5e05c8ecf4a1d2c81a7dbca5944fb52b1937ffff
parent 8703a28973688fbf0e4fdfa47f4fa2139d2f9a34
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date: Fri, 5 Oct 2018 12:17:24 +0200
Add Release notes for release 0.2
Diffstat:
| M | README.md | | | 64 | ++++++++++++++++++++++++++++++++++++++++++++-------------------- |
1 file changed, 44 insertions(+), 20 deletions(-)
diff --git a/README.md b/README.md
@@ -1,30 +1,54 @@
-# StarEnclosures
+StarEnclosures
+==============
-The purpose of this library is to extract enclosures from raw geometry. An
-enclosure is a set of triangles enclosing a given volume. The library manages
-vertices and triangles duplicates, easing the scene definition process.
+Overview
+--------
-## How to build
+The purpose of Star-enclosures is to extract enclosures from raw
+geometry. An enclosure is a set of triangles enclosing a given volume.
+The enclosure notion extends to open enclosures for which there is no
+inside or outside. For every detected enclosure, the library provides
+the set of involved triangle sides as well as the set of involved media
+and a few metrics (number of triangles, ...).
+
+The library allows geometry to be added by subsets of triangles and
+manages vertices and triangles duplicates as long as the duplicate
+information is coherent, easing the scene definition process.
+
+Also the convention regarding FRONT/BACK sides for input triangles as
+well as the convention regarding normals' orientation for output
+triangles can be set.
+
+How to build
+------------
StarEnclosures 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/) and
-[Star-3D](https://gitlab.com/meso-star/star-3d/) libraries. Additionaly, two
-more libraries are needed to build tests:
+[RCMake](https://gitlab.com/vaplv/rcmake/) package to build. It also
+depends on the [RSys](https://gitlab.com/vaplv/rsys/) and
+[Star-3D](https://gitlab.com/meso-star/star-3d/) libraries. Additionaly,
+two more libraries are needed to build tests:
[Star-SP](https://gitlab.com/meso-star/star-sp/) and
[Star-3DUT](https://gitlab.com/meso-star/star-3dut/).
-First ensure that CMake and a C compiler that implements the OpenMP 1.2 are
-installed on your system. Then install the RCMake package as well as all 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.
+First ensure that CMake and a C compiler that implements the OpenMP 1.2
+are installed on your system. Then install the RCMake package as well as
+all 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.
+
+Release notes
+-------------
+
+### Version 0.2
-## License
+- Add the support of enclosures with multiple media.
+- Allow to set the FRONT/BACK convention for input triangles.
+- Allow to set the normal convention for output triangles.
-StarEnclosures is Copyright (C) |Meso|Star> 2018 (<contact@meso-star.com>).
-It is free software released under the GPLv3+ license. You are welcome to
-redistribute it under certain conditions; refer to the COPYING files for
-details.
+License
+-------
+StarEnclosures is Copyright (C) |Meso|Star> 2018
+(<contact@meso-star.com>). It is free software released under the GPLv3+
+license. You are welcome to redistribute it under certain conditions;
+refer to the COPYING files for details.
