commit 1dd657ac3ae3112cce9368acbaeb8a2b411d6561 parent 2023b23df399b6e056bd25fa2f63936ea94b6ebb Author: Vincent Forest <vincent.forest@meso-star.com> Date: Fri, 19 Apr 2024 14:17:07 +0200 Rewrite the "How to build" section of the README file List the requirements to make them less wordy and simpler to read. Complete rewrite the installation section regarding using a POSIX Makefile and no longer CMake as build system. Diffstat:
| M | README.md | | | 46 | +++++++++++++++++++++++++++------------------- |
1 file changed, 27 insertions(+), 19 deletions(-)
diff --git a/README.md b/README.md @@ -19,25 +19,33 @@ Also the convention regarding FRONT/BACK sides for input triangles as well as the convention regarding normals' orientation for output triangles can be set. -How to build ------------- - -Star-enclosures-3d relies on the [CMake](http://www.cmake.org) and the -[RCMake](https://gitlab.com/vaplv/rcmake/) package to build. It also -depends on the [RSys](https://gitlab.com/vaplv/rsys/) and -[Star-3D](https://gitlab.com/meso-star/star-3d/) libraries. Additionaly, -two more libraries are needed to build tests: -[Star-SP](https://gitlab.com/meso-star/star-sp/) and -[Star-3DUT](https://gitlab.com/meso-star/star-3dut/). - -First ensure that CMake and a C compiler that implements the OpenMP 2.0 API -are installed on your system. Then install the RCMake package as well as -all 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. - -Release notes -------------- +## Requirements + +- C compiler +- POSIX make +- pkg-config +- [RSys](https://gitlab.com/vaplv/rsys) +- [Star 3D](https://gitlab.com/meso-star/star-3d) +- [Star 3DUT](https://gitlab.com/meso-star/star-3dut) + (optinal for tests) +- [Star SamPling](https://gitlab.com/meso-star/star-sp) + (optinal for tests) + +## Installation + +Edit config.mk as needed, then run: + + make clean install + +## Release notes + +### Version 0.7 + +- Replace CMake by Makefile as build system. +- Update compiler and linker flags to increase the security and + robustness of generated binaries. +- Provide a pkg-config file to link the library as an external + dependency. ### Version 0.6