commit 02f86514d122c90858dcbd578dab74872612bb15 parent 0e1d6441062aae2ce886e4875a834e6271462d54 Author: Christophe Coustet <christophe.coustet@meso-star.com> Date: Wed, 11 Jan 2023 18:17:54 +0100 First true version of Readme.md file Diffstat:
| M | README.md | | | 35 | +++++++++++++++++++++++++++++------ |
1 file changed, 29 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md @@ -1,10 +1,33 @@ # Star-Cad -Star-Cad is a gmsh wrapper library. +Star-Cad is mostly a wrapper for the gmsh library. It only provides access to +some of the OpenCascade kernel features, with the benefit of simplified use. One +of the most valuable features of Star-Cad is that it implements an automated +reference counting mecanism that eases geometry reference, whilst gmsh system +of tags doesn't ensure tag persistence accross geometry deletions. -Star-Cad depends on: -- gmsh https://gmsh.info/ -- Rsys https://gitlab.com/vaplv/rsys +## How to build -To build Star-Cad modify the config.mk to find Rsys and Gmsh on your system. -Star-Cad is build as a static library. +The library uses [CMake](http://www.cmake.org) and the +[RCMake](https://gitlab.com/vaplv/rcmake/#tab-readme) package to build. It also +depends on the +[Gmsh](https://gmsh.info/) and +[RSys](https://gitlab.com/vaplv/rsys/#tab-readme) libraries. + +First ensure that CMake is installed on your system. Then install the RCMake +package as well as all the aforementioned prerequisites. Then 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 + +### Version 0.1.0 + +Initial version. + +## License + +Copyright (C) 2022-2023, 2021 |Meso|Star> (<contact@meso-star.com>). +Star-Cad is free software released under the GPL v3+ license: GNU GPL +version 3 or later. You are welcome to redistribute it under certain +conditions; refer to the COPYING file for details.