commit ce36d470f338985c9ced7362e124d1ae2b79c2fd
parent 1c86c7fd4af7cfc939ae012f818a98766201b3e4
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Tue, 25 Apr 2023 11:57:45 +0200
Write release notes for version 0.1.1
Diffstat:
1 file changed, 13 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
@@ -1,5 +1,4 @@
-Star-geometry-2d
-================
+# Star-geometry-2d
The purpose of this library is to help create clean and decorated 2D
geometries. These geometries are suitable to be partitioned into
@@ -8,8 +7,7 @@ mechanisms to construct segment-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-2d relies on the [CMake](http://www.cmake.org) and the
[RCMake](https://gitlab.com/vaplv/rcmake/) package to build. It also
@@ -21,17 +19,23 @@ 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 a typo in the `sgX2d.h` header apparently due to fingers getting
+ tangled on the keyboard.
### Version 0.1
First version and implementation of the star-geometry-2d API.
-- Creation of geometries in multiple steps, allowing advanced
- deduplication and application-data management
+- 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
-- Dump of geometries as OBJ or VTK files or as C code chunks
+## License
License
-------
