commit 0ffb8b24f64b4dd76fb92854e78ff496288de868
parent 9b99310b4b28eea45831a5786febc42ff3e3ab68
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Thu, 14 Dec 2023 16:35:27 +0100
Rewrite the README file
Make the description of the requirements concise and completely rewrite
the installation section regarding the use of a POSIX Makefile and no
longer CMake as the first build system.
Wraps the text in 72 columns to match the convention of plain text
e-mails. It can therefore be sent as a publication announcement e-mail
without being reformatted.
Diffstat:
| M | README.md | | | 34 | ++++++++++++++++++---------------- |
1 file changed, 18 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
@@ -7,19 +7,19 @@ mechanisms to construct triangle-related app data, detect
inconsistencies and dump the resulting geometry in various formats (OBJ,
VTK, C code chunks).
-## How to build
+## Requirements
-Star-geometry-3d relies on the [CMake](http://www.cmake.org) and the
-[RCMake](https://gitlab.com/vaplv/rcmake/) package to build and
-depends on the [RSys](https://gitlab.com/vaplv/rsys/) library. Some tests
-also depend on the [SD3UT](https://gitlab.com/meso-star/star-3dut/)
-library.
+- C compiler
+- POSIX make
+- pkg-config
+- [RSys](https://gitlab.com/vaplv/rsys)
+- [Star 3DUT](https://gitlab.com/meso-star/star-3dut) (optional)
-First ensure that CMake and a C compiler that is compliant with C89 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.
+## Installation
+
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
@@ -36,13 +36,15 @@ variable the install directories of its dependencies.
First version and implementation of the star-geometry-3d API.
-- Creation of geometries in multiple steps, allowing advanced deduplication and
- application-data management
+- Creation of geometries in multiple steps, allowing advanced
+ deduplication and application-data management
- Dump of geometries as OBJ or VTK files or as C code chunks
## License
Copyright © 2019, 2020, 2023 [|Méso|Star>](https://www.meso-star.com)
-(<contact@meso-star.com>). It is free software released under the GPLv3+
-license: GNU GPL version 3 or later. You are welcome to redistribute it under
-certain conditions; refer to the COPYING files for details.
+(contact@meso-star.com)
+
+It is free software released under the GPLv3+ license: GNU GPL version 3
+or later. You are welcome to redistribute it under certain conditions;
+refer to the COPYING files for details.
