commit 94ce3187ca34f9469a7a32bbde7d076cc2a8d912
parent de1e9eabf78dea116ebbcc010df751bf8cf1d570
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 21 Jul 2023 17:25:57 +0200
Rewrite the README file
Add a requirements section that lists project dependencies. Complete
rewrite of the installation procedure concerning the use of a POSIX
Makefile and no longer CMake as the first build system.
Diffstat:
2 files changed, 19 insertions(+), 20 deletions(-)
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Star-UnstructuredVolumetricMesh
+# Star Unstructured Volumetric Mesh
Star-UVM is a C library whose goal is to manage unstructured volumetric meshes
defined by a soup of tetrahedra. Once spatially partitioned, the user can
@@ -11,21 +11,20 @@ indices and barycentric coordinates, needed to retrieve the properties attached
to each tetrahedron. These properties can thus be managed externally without
arbitrary constraints imposed by Star-UVM on their size, alignment or type.
-## How to build
+## Requirements
-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/) and
-[Embree](https://embree.github.io/) libraries. It is compatible
-GNU/Linux on x86-64 architectures.
+- C compiler (C99)
+- POSIX make
+- pkg-config
+- [Embree](https://github.com/embree/embree)
+- [RSys](https://gitlab.com/vaplv/rsys)
+- [Star-Mesh](https://gitlab.com/meso-star/star-mesh) (optional)
-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.
+## Installation
+
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
@@ -45,8 +44,8 @@ Update of the acceleration data structure backend from Embree3 to Embree4
## License
-Copyright (C) 2020-2023 [|Méso|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.
+Copyright (C) 2020-2023 |Méso|Star> (contact@meso-star.com)
+
+Star-UVM 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.
diff --git a/config.mk b/config.mk
@@ -29,7 +29,7 @@ RSYS_VERSION = 0.6
RSYS_CFLAGS = $$($(PKG_CONFIG) $(PCFLAGS) --cflags rsys)
RSYS_LIBS = $$($(PKG_CONFIG) $(PCFLAGS) --libs rsys)
-# Optional (for test only)
+# Optional (required only by suvm_voxelize tool)
SMSH_VERSION = 0.1
SMSH_CFLAGS = $$($(PKG_CONFIG) $(PCFLAGS) --cflags smsh)
SMSH_LIBS = $$($(PKG_CONFIG) $(PCFLAGS) --libs smsh)
