commit 30781ac854b139e7fd55b78e4205232a14024a29
parent 1dd657ac3ae3112cce9368acbaeb8a2b411d6561
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 19 Apr 2024 14:22:18 +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 | | | 33 | ++++++++++++++++----------------- |
1 file changed, 16 insertions(+), 17 deletions(-)
diff --git a/README.md b/README.md
@@ -1,8 +1,6 @@
-Star-enclosures-3d
-==================
+# Star-enclosures-3d
-Overview
---------
+## Overview
The purpose of Star-enclosures-3d is to extract enclosures from raw
geometry. An enclosure is a set of triangles enclosing a given volume.
@@ -49,7 +47,8 @@ Edit config.mk as needed, then run:
### Version 0.6
-- Major rework on the code that groups connex components to create enclosures.
+- Major rework on the code that groups connex components to create
+ enclosures.
- Add tests showing bugs at the grouping stage in previous release.
- Add debug code that allows to dump how connex components are grouped.
- Fix compilation warnings.
@@ -57,15 +56,15 @@ Edit config.mk as needed, then run:
### Version 0.5.5
-- Fixes a crash linked to numerical accuracy that caused connex components
- grouping to loop forever.
+- Fixes a crash linked to numerical accuracy that caused connex
+ components grouping to loop forever.
### Version 0.5.4
-- Fixes the (rare) situation where temporary local variables could be used in
- a unitialized way in the `senc3d_scene_create` function.
-- Sets the required version of Star-SampPling to 0.12. This version fixes
- compilation errors with gcc 11 but introduces API breaks.
+- Fixes the (rare) situation where temporary local variables could be
+ used in a unitialized way in the `senc3d_scene_create` function.
+- Sets the required version of Star-SampPling to 0.12. This version
+ fixes compilation errors with gcc 11 but introduces API breaks.
### Version 0.5.3
@@ -111,10 +110,11 @@ triangles.
### Version 0.4
-- Change signature of the senc_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.
+- Change signature of the `senc_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.
@@ -147,8 +147,7 @@ triangles.
- Allow to set the FRONT/BACK convention for input triangles.
- Allow to set the normal convention for output triangles.
-License
--------
+## License
Copyright © 2018-2020, 2023, 2024
[|Méso|Star>](https://www.meso-star.com) (<contact@meso-star.com>).
