commit 5f67824ce5520102ad2e852120b6eb6b4f6c0e92 parent 8e2ceb21569178c83d2cef4e659224d189e27ff3 Author: Vincent Forest <vincent.forest@meso-star.com> Date: Fri, 18 Sep 2020 16:57:02 +0200 Add a README file Diffstat:
| A | README.md | | | 27 | +++++++++++++++++++++++++++ |
1 file changed, 27 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -0,0 +1,27 @@ +# Star-UnstructuredVolumetricMesh + +Star-UVM is C library whose purpose is to manage unstructured meshes +storing f volumetric data. + +## How to build + +Star-UVM relies on the [CMake](http://www.cmake.org) and the +[RCMake](https://gitlab.com/vaplv/rcmake/) packages to build. It also depends +on the [RSys](https://gitlab.com/vaplv/rsys/), library. It is compatible +GNU/Linux 64 bits on x86-64 architectures. + +First ensure that CMake is installed on your system. Then install the RCMake +package as well as 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. The +resulting project can be edited, built, tested and installed as any CMake +project. Refer to the [CMake](https://cmake.org/documentation) for further +informations on CMake. + +## License + +Copyright (C) 2020 [|Meso|Star>](https://www.meso-star.com) +(<contact@meso-star.com>). Star-UnstructuredVolumetricMesh 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.