commit cbd2bd35f791c4de9bc9552179b644d8c3472d7f parent d549708768527c3796abedc38d8919630bd616a9 Author: Vincent Forest <vincent.forest@meso-star.com> Date: Fri, 19 Apr 2024 15:41:49 +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 | | | 35 | +++++++++++++++++------------------ |
1 file changed, 17 insertions(+), 18 deletions(-)
diff --git a/README.md b/README.md @@ -16,24 +16,23 @@ Also the convention regarding FRONT/BACK sides for input segments as well as the convention regarding normals' orientation for output segments can be set. -How to build ------------- - -Star-enclosures-2d 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-2D](https://gitlab.com/meso-star/star-2d/) libraries. Additionaly, -one more library is needed to build tests -([Star-SP](https://gitlab.com/meso-star/star-sp/)). - -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. - -Known Bugs ----------- +## Requirements + +- C compiler +- POSIX make +- pkg-config +- [RSys](https://gitlab.com/vaplv/rsys) +- [Star 2D](https://gitlab.com/meso-star/star-3d) +- [Star SamPling](https://gitlab.com/meso-star/star-sp) + (optinal for tests) + +## Installation + +Edit config.mk as needed, then run: + + make clean install + +## Known Bugs In some rare circumstances, raytracing accuracy problems can lead to incorrect connex components pairing. This bug has already been fixed