commit 8a15da4697ca7d24e2d240e0308f2a5246b28f18
parent c4d49b8b16b567e96cd5af9c770ac79108684b22
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Thu, 13 Jul 2023 16:25:04 +0200
Rewrite the README file
Cleanup and small rewrite of the preview. Add a requirements section
that lists the dependencies of the project. And complete rewrite of the
installation procedure regarding the use of a POSIX Makefile and no
longer CMake.
Diffstat:
| M | README.md | | | 41 | +++++++++++++++++++---------------------- |
1 file changed, 19 insertions(+), 22 deletions(-)
diff --git a/README.md b/README.md
@@ -1,26 +1,22 @@
# Star 3D shapes from Alias Wavefront geometries
-This library creates Star-3D shapes from polygonal geometries saved in
-the Alias Wavefront obj/mtl fileformats.
-
-## How to build
-
-This library depends on the
-[AW](https://gitlab.com/vaplv/loader_aw/#tab-readme) library to load Alias
-Wavefront files, on the [Polygon](https://gitlab.com/vaplv/polygon/#tab-readme)
-library to triangulate polygonal faces and on the
-[Star-3D](https://gitlab.com/meso-star/star-3d/#tab-readme) library to define
-the in-core representation of the loaded shapes. It also uses
-[CMake](http://www.cmake.org) and the
-[RCMake](https://gitlab.com/vaplv/rcmake/#tab-readme) package to build and
-depends on the [RSys](https://gitlab.com/vaplv/rsys/#tab-readme) library.
-
-First ensure that CMake is installed on your system. Then install the RCMake
-package as well as the RSys, AW, Polygon and Star-3D libraries. Finally
-generate the project from the `cmake/CMakeLists.txt` file by appending to the
-`CMAKE_PREFIX_PATH` variable the install directories of the previously defined
-dependencies. The generated project can be edited, built, tested and installed
-as any CMake project.
+
+Star-3DAW creates [Star-3D](https://gitlab.com/meso-star/star-3d) shapes from
+polygonal geometries saved in the Alias Wavefront obj file format.
+
+## Requirments
+
+C compiler, POSIX make, pkg-config, and the header files and libraries from
+[AW](https://gitlab.com/vaplv/loader_aw),
+[Polygon](https://gitlab.com/vaplv/polygon),
+[Star-3D](https://gitlab.com/meso-star/star-3d) and
+[RSys](https://gitlab.com/vaplv/rsys).
+
+## Installation
+
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
@@ -36,7 +32,8 @@ breaks introduce by this update.
## License
-Copyright (C) 2015, 2016, 2020, 2021 |Meso|Star> (<contact@meso-star.com>).
+Copyright (C) 2015, 2016, 2020, 2021 |Meso|Star> (contact@meso-star.com)
+
Star-3DAW is free software released under the CeCILLv2.1 license. You are
welcome to redistribute it under certain conditions; refer to the COPYING files
for details.
