commit 38654a51ab9a8fc795cd0fba81f7828d9ea51677
parent cbd2bd35f791c4de9bc9552179b644d8c3472d7f
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 19 Apr 2024 15:43:33 +0200
Modify README file
Make the header syntax consistent. We used to use a mixture of Atx and
Setext syntaxes. From now on, we'll only use the atx header syntax.
Wraps the text in 72 columns to match the convention of plain text
e-mails. It can therefore be sent as a publication announcement e-mail
without being reformatted.
Diffstat:
| M | README.md | | | 47 | +++++++++++++++++++++++------------------------ |
1 file changed, 23 insertions(+), 24 deletions(-)
diff --git a/README.md b/README.md
@@ -1,5 +1,4 @@
-Star-enclosures-2d
-==================
+# Star-enclosures-2d
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
@@ -38,13 +37,12 @@ In some rare circumstances, raytracing accuracy problems can lead to
incorrect connex components pairing. This bug has already been fixed
in star-enclosures-3d but is still present in star-enclosures-2d.
-Release notes
--------------
+## Release notes
### Version 0.5.5
-Fixes the (rare) situation where temporary local variables could be used in a
-unitialized way in the `senc2d_scene_create` function.
+Fixes the (rare) situation where temporary local variables could be used
+in a unitialized way in the `senc2d_scene_create` function.
### Version 0.5.4
@@ -57,8 +55,8 @@ Fix API break on filter function introduced by Star-2D 0.5.
### Version 0.5.2
-BugFix: enclosures including multiple media could end with invalid primitive
-count.
+BugFix: enclosures including multiple media could end with invalid
+primitive count.
### Version 0.5.1
@@ -73,8 +71,8 @@ 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 when overlapping segments are
- detected.
+ currently detected. Do not extract enclosures when overlapping
+ segments are detected.
- Make enclosure IDs consistent across runs.
- Fix enclosure extraction when all segments Ny component is zero.
- More robust on invalid scenes.
@@ -82,8 +80,8 @@ segments.
### Version 0.4.2
- Fix global id of segments; releases 0.4.0 and 0.4.1 are broken
-- Reintroduce an API call to get the global id in user space of a global unique
- segment after deduplication
+- Reintroduce an API call to get the global id in user space of a global
+ unique segment after deduplication
### Version 0.4.1
@@ -91,11 +89,11 @@ segments.
### Version 0.4
-- Change signature of the `senc2d_scene_add_geometry` API. Thus this release is
- **not compatible** with previous ones. The `global_id` callback that was
- ill-defined is removed and 2 callbacks are added to manage client-app data
- when deduplicating geometry. These 2 callback allow a proper client-app
- management of global ids.
+- Change signature of the `senc2d_scene_add_geometry` API. Thus this
+ release is **not compatible** with previous ones. The `global_id`
+ callback that was ill-defined is removed and 2 callbacks are added to
+ manage client-app data when deduplicating geometry. These 2 callback
+ allow a proper client-app management of global ids.
- Remove execution time for analysis steps from the log.
### Version 0.3.1
@@ -113,8 +111,9 @@ segments.
### Version 0.2.2
- BugFix when grouping components into enclosures.
-- Add a warning message in log when edges that could surround a hole are found
- (edges with at least one unshared vertex and different media on its sides).
+- Add a warning message in log when edges that could surround a hole are
+ found (edges with at least one unshared vertex and different media on
+ its sides).
### Version 0.2.1
@@ -126,11 +125,11 @@ BugFix: needed data cleaning on computation canceling.
- Allow to set the FRONT/BACK convention for input segments.
- Allow to set the normal convention for output segments.
-License
--------
+## License
Copyright © 2018-2021, 2023 [|Meso|Star>](https://www.meso-star.com)
(<contact@meso-star.com>).
-Star-enclosures-2d is free software released under the GPLv3+ license: GNU GPL
-version 3 or later. You are welcome to redistribute it under certain
-conditions; refer to the COPYING file for details.
+
+Star-enclosures-2d is free software released under the GPLv3+ license:
+GNU GPL version 3 or later. You are welcome to redistribute it under
+certain conditions; refer to the COPYING file for details.
