star-geometry-2d

Cleaning and decorating 2D geometries
git clone git://git.meso-star.fr/star-geometry-2d.git
Log | Files | Refs | README | LICENSE

README.md (1684B)

      1 # Star-geometry-2d
      2 
      3 The purpose of this library is to help create clean and decorated 2D
      4 geometries. These geometries are suitable to be partitioned into
      5 enclosures using the star-enclosures-2d library. It also provides
      6 mechanisms to construct segment-related app data, detect
      7 inconsistencies and dump the resulting geometry in various formats (OBJ,
      8 VTK, C code chunks).
      9 
     10 ## How to build
     11 
     12 Star-geometry-2d relies on the [CMake](http://www.cmake.org) and the
     13 [RCMake](https://gitlab.com/vaplv/rcmake/) package to build. It also
     14 depends on the [RSys](https://gitlab.com/vaplv/rsys/) library.
     15 
     16 First ensure that CMake and a C compiler that is compliant with C89 are
     17 installed on your system. Then install the RCMake package as well as all
     18 the aforementioned prerequisites. Finally generate the project from the
     19 `cmake/CMakeLists.txt` file by appending to the `CMAKE_PREFIX_PATH`
     20 variable the install directories of its dependencies.
     21 
     22 ## Release notes
     23 
     24 ### Version 0.1.1
     25 
     26 - Fixed help headers failing to compile when included in C++ files.
     27 - Fixed a typo in the `sgX2d.h` header apparently due to fingers getting
     28   tangled on the keyboard.
     29 
     30 ### Version 0.1
     31 
     32 First version and implementation of the star-geometry-2d API.
     33 
     34 - Creation of geometries in multiple steps, allowing advanced
     35   deduplication and application-data management
     36 - Dump of geometries as OBJ or VTK files or as C code chunks
     37 
     38 ## License
     39 
     40 Copyright © 2019, 2020, 2023 [|Méso|Star>](https://www.meso-star.com)
     41 (<contact@meso-star.com>). It is free software released under the GPLv3+
     42 license: GNU GPL version 3 or later. You are welcome to redistribute it under
     43 certain conditions; refer to the COPYING files for details.