commit cd6826d0afc993856595b1a1d8cfcf359611066f
parent 85f061bd5a00909f53ed4645006810f7fb8c3fee
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date: Fri, 13 Dec 2019 17:26:07 +0100
Improve library description
Diffstat:
1 file changed, 10 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
@@ -1,9 +1,12 @@
-Star-geoemtry
+Star-geometry
=============
The purpose of this library is to help create clean and decorated 3D
geometries. These geometries are suitable to be partitioned into
-enclosures using the star-enclosures library.
+enclosures using the star-enclosures library. It also provides
+mechanisms to construct triangle-related app data, detect
+inconsistencies and dump the resulting geometry in various formats (OBJ,
+VTK, C code).
How to build
------------
@@ -25,17 +28,17 @@ Release notes
First version and implementation of the Star-geometry 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;
-- Creation of reports on the geometry and its creation;
+- Creation of reports on the geometry and its creation;
-- Dump of reports as OBJ or VTK files;
+- Dump of reports as OBJ or VTK files;
License
-------
-Copyright (C) 2019 \|Meso\|Star>
+Copyright (C) 2019 |Meso|Star>
(<a href="mailto:contact@meso-star.com" class="email">contact@meso-star.com</a>).
Stardis is free software released under the GPLv3+ license: GNU GPL
version 3 or later. You are welcome to redistribute it under certain
