commit c738f8986897dd600cae81fde0b0f004b36cc62a
parent 7d01ff515b9e865e6216ed9f290b2623ede492f5
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Tue, 25 Apr 2023 11:33:00 +0200
Write release notes for version 0.1.1
Diffstat:
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
@@ -1,5 +1,4 @@
-Star-geometry-3d
-================
+# Star-geometry-3d
The purpose of this library is to help create clean and decorated 3D
geometries. These geometries are suitable to be partitioned into
@@ -8,8 +7,7 @@ mechanisms to construct triangle-related app data, detect
inconsistencies and dump the resulting geometry in various formats (OBJ,
VTK, C code chunks).
-How to build
-------------
+## How to build
Star-geometry-3d relies on the [CMake](http://www.cmake.org) and the
[RCMake](https://gitlab.com/vaplv/rcmake/) package to build and
@@ -23,20 +21,22 @@ 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
--------------
+## Release notes
+
+### Version 0.1.1
+
+- Fixed help headers failing to compile when included in C++ files.
+- Fixed compilation warnings detected by GCC 11.
### Version 0.1
First version and implementation of the star-geometry-3d API.
-- Creation of geometries in multiple steps, allowing advanced
- deduplication and application-data management
-
-- Dump of geometries as OBJ or VTK files or as C code chunks
+- Creation of geometries in multiple steps, allowing advanced deduplication and
+ application-data management
+- Dump of geometries as OBJ or VTK files or as C code chunks
-License
--------
+## License
Star-geometry-3d is Copyright (C) 2019-2020 |Meso|Star>
(<a href="mailto:contact@meso-star.com" class="email">contact@meso-star.com</a>).
