commit a2528888489d359ed4bb8b7125443cc4751c24e4
parent 197c43ff7a573266a5220f72f73aefdb194bbada
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date: Fri, 5 Oct 2018 12:28:28 +0200
Add Release notes for release 0.2
Diffstat:
| M | README.md | | | 62 | ++++++++++++++++++++++++++++++++++++++++++-------------------- |
1 file changed, 42 insertions(+), 20 deletions(-)
diff --git a/README.md b/README.md
@@ -1,29 +1,51 @@
-# StarEnclosures 2D
+StarEnclosures 2D
+=================
-The purpose of this library is to extract enclosures from raw 2D geometry. An
-enclosure is a set of segments enclosing a given area. The library manages
-vertices and segments duplicates, easing the scene definition process.
+The purpose of Star-enclosures-2D is to extract enclosures from raw
+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, ...).
-## How to build
+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.
+
+Also the convention regarding FRONT/BACK sides for input segments as
+well as the convention regarding normals' orientation for output
+segments can be set.
+
+How to build
+------------
StarEnclosures 2D 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-2D](https://gitlab.com/meso-star/star-2d/) libraries. Additionaly, one
-more library is 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-2D](https://gitlab.com/meso-star/star-2d/) libraries. Additionaly,
+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 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 2.0
+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 segments.
+- Allow to set the normal convention for output segments.
-StarEnclosures 2D 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 2D is Copyright (C) \\\|Meso\\\|Star> 2018
+(<a href="mailto:contact@meso-star.com" class="email">contact@meso-star.com</a>).
+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.
