commit 8a1303c992cf30257daa6a5c55b6c41088a4abc4
parent 85381ebb55da0d988b6bb4c1e6eb069f3176d300
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Mon, 17 Jul 2023 16:06:53 +0200
Rewrite the README file
Cleanup and small rewrite of the preview. Add a requirements section
that lists the dependencies of the project. Complete rewrite of the
installation procedure regarding the use of POSIX make and no longer
CMake.
Diffstat:
| M | README.md | | | 30 | +++++++++++++++--------------- |
1 file changed, 15 insertions(+), 15 deletions(-)
diff --git a/README.md b/README.md
@@ -1,17 +1,18 @@
# Star-3DUtilityToolkit
-This library provides functionalities to create 3D shapes.
+The Star-3DUT library generates the triangular mesh of 3D geometric shapes.
+See the `s3dut.h` header file for the list of supported geometries.
-## How to build
+## Requirements
-The library uses [CMake](http://www.cmake.org) and the
-[RCMake](https://gitlab.com/vaplv/rcmake/#tab-readme) package to build. It also
-depends on the [RSys](https://gitlab.com/vaplv/rsys/#tab-readme) library.
+C compiler, POSIX make, pkg-config and
+[RSys](https://gitlab.com/vaplv/rsys/) header files and library.
-First ensure that CMake is installed on your system. Then install the RCMake
-package as well as all the RSys library. Then 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
@@ -47,7 +48,7 @@ the install directories of its dependencies.
thick triangulated super shape (possibly) truncated along the Z axis.
Truncated ends can be closed or left open.
- Increase min number of slices for `s3dut_create_hemisphere` from 2 to 3.
-
+
### Version 0.2
- Add the `s3dut_create_hemisphere` function that creates a triangulated UV
@@ -55,9 +56,8 @@ the install directories of its dependencies.
## License
-Copyright (C) 2016, 2017, 2020, 2021 |Meso|Star> (<contact@meso-star.com>).
-Star-3DUtilityToolkit is free software released under the
-[OSI](http://opensource.org)-approved GPL v3+ license. You are welcome to
-redistribute it under certain conditions; refer to the COPYING file for
-details.
+Copyright (C) 2016, 2017, 2020, 2021 |Meso|Star> (contact@meso-star.com)
+Star-3DUT is free software released under 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.
