commit 7fdd7d84f4467f165458d0e59cb98e9051d64a3a
parent cd47ac249b06c0643b4138ae30a961e3135ff74d
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date: Tue, 7 Jul 2020 10:02:42 +0200
Fix release notes for release 0.5
Diffstat:
1 file changed, 11 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
@@ -6,11 +6,11 @@ geometry. An enclosure is a set of segments enclosing a given area. 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 segment sides as well as the set of involved media and a few
-metrics (number of segments, ...).
+metrics (number of segments, volume, area, ...).
-The library allows geometry to be added by subsets of segments and
-manages vertices and segments duplicates as long as the duplicate
-information is coherent, easing the scene definition process.
+From release 0.5, the geometry has to be provided at once, with no
+duplicates nor zero-length segments. To help ensuring this constraints,
+one can rely on the star-geometry-2d library.
Also the convention regarding FRONT/BACK sides for input segments as
well as the convention regarding normals' orientation for output
@@ -26,7 +26,7 @@ depends on the [RSys](https://gitlab.com/vaplv/rsys/) and
one more library is needed to build tests
([Star-SP](https://gitlab.com/meso-star/star-sp/)).
-First ensure that CMake and a C compiler that implements the OpenMP 2.0
+First ensure that CMake and a C compiler that implements the OpenMP 2.0 API
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`
@@ -48,12 +48,16 @@ Release notes
### Version 0.5
+This release breaks the API as geometry cannot be provided through calls
+to an add-like call anymore. Instead the whole geometry must be provided
+at once, with no duplicates (either vertices or segments) nor zero-area
+segments.
+
- Compute volume (in m^2) and surface (in m) of enclosures.
- Report overlapping segments.
Only segments with a common vertex are currently detected.
- Do not extract enclosures anymore when overlapping segments are
- detected.
+ Do not extract enclosures when overlapping segments are detected.
- Make enclosure IDs consistent across runs.
