commit d13aa367d3c37b68af7569cf0820fa696a17865a
parent 172821dc7d5845a59d9ee555c417e750a2470a2d
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 27 Oct 2023 14:35:25 +0200
Wraps the README text in 72 columns
This matches 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 | | | 50 | ++++++++++++++++++++++++++------------------------ |
1 file changed, 26 insertions(+), 24 deletions(-)
diff --git a/README.md b/README.md
@@ -1,7 +1,8 @@
# Star-3DUtilityToolkit
-The Star-3DUT library generates the triangular mesh of 3D geometric shapes.
-See the `s3dut.h` header file for the list of supported geometries.
+The Star-3DUT library generates the triangular mesh of 3D geometric
+shapes. See the `s3dut.h` header file for the list of supported
+geometries.
## Requirements
@@ -20,8 +21,8 @@ Edit config.mk as needed, then run:
### Version 0.3.3
-- Sets the CMake minimum version to 3.1: since CMake 3.20, version 2.8 has
- become obsolete.
+- Sets the CMake minimum version to 3.1: since CMake 3.20, version 2.8
+ has become obsolete.
### Version 0.3.2
@@ -29,37 +30,38 @@ Edit config.mk as needed, then run:
### Version 0.3.1
-- Update the version of the RSys dependency to 0.6: replace the deprecated
- `[N]CHECK` macros by the new macro `CHK`.
+- Update the version of the RSys dependency to 0.6: replace the
+ deprecated `[N]CHECK` macros by the new macro `CHK`.
### Version 0.3
-- Add the `s3dut_create_thin_cylinder` function that creates a triangulated
- cylinder. Both ends can be closed or left open.
+- Add the `s3dut_create_thin_cylinder` function that creates a
+ triangulated cylinder. Both ends can be closed or left open.
- Add the `s3dut_create_thick_cylinder` function that creates a thick
triangulated cylinder. Both ends can be closed or left open.
-- Add the `s3dut_create_truncated_sphere` function that creates a triangulated
- UV sphere (possibly) truncated along the Z axis. Truncated ends can be closed
- or left open.
-- Add the `s3dut_create_thick_truncated_sphere` function that creates a thick
- triangulated UV sphere (possibly) truncated along the Z axis. Truncated ends
- can be closed or left open.
-- Add the `s3dut_create_super_shape` function that creates a triangulated super
- shape.
-- Add the `s3dut_create_thick_truncated_super_shape` function that creates a
- thick triangulated super shape (possibly) truncated along the Z axis.
+- Add the `s3dut_create_truncated_sphere` function that creates a
+ triangulated UV sphere (possibly) truncated along the Z axis.
+ Truncated ends can be closed or left open.
+- Add the `s3dut_create_thick_truncated_sphere` function that creates a
+ thick triangulated UV sphere (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.
+- Add the `s3dut_create_super_shape` function that creates a
+ triangulated super shape.
+- Add the `s3dut_create_thick_truncated_super_shape` function that
+ creates a 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
- hemisphere oriented along the positive Z axis.
+- Add the `s3dut_create_hemisphere` function that creates a triangulated
+ UV hemisphere oriented along the positive Z axis.
## License
Copyright (C) 2016, 2017, 2020, 2021, 2023 |Méso|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.
+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.
