commit 27d13ec5bc10a37062c6582c5024653c85ccdcaa
parent 0caf6b196c1fe9b847521ad6c96380dd90998612
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 21 Jul 2023 16:09:32 +0200
Rewrite the README file
Cleanup and small rewrite of the preview. 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:
| M | README.md | | | 44 | +++++++++++++++++++++----------------------- |
1 file changed, 21 insertions(+), 23 deletions(-)
diff --git a/README.md b/README.md
@@ -1,28 +1,26 @@
# Star-Mesh
-Star-Mesh is a C library that loads surfacic/volumetric meshes saved wrt the
-Star-Mesh file format.
-
-## How to build
-
-Star-Mesh is compatible 64-bit POSIX systems. It 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 optionally depends on
-[scdoc](https://sr.ht/~sircmpwn/scdoc/) which, if available, is used to generate
-the man page of the Star-Mesh file format.
-
-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.
+Star-Mesh loads surfacic or volumetric meshes saved in Star-Mesh file format.
+See smsh.5 for details.
+
+## Requirements
+
+- C compiler
+- POSIX make
+- pkg-config
+- [RSys](https://gitlab.com/vaplv/rsys)
+- [scdoc](https://git.sr.ht/~sircmpwn/scdoc)
+
+## Installation
+
+Edit config.mk as needed, then run:
+
+ make clean install
## License
-Copyright (C) 2020-2023 [|Méso|Star>](https://www.meso-star.com)
-(<contact@meso-star.com>). Star-Mesh 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-Mesh 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.
