commit 603c881af391389e3382fd3a821525305e7ea5b6
parent 30d8f1a7d59ecc31eadc9c0f443512600893a65b
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 27 Oct 2023 10:59:50 +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 | | | 59 | +++++++++++++++++++++++++++++++---------------------------- |
1 file changed, 31 insertions(+), 28 deletions(-)
diff --git a/README.md b/README.md
@@ -1,24 +1,26 @@
# Star-VoXel
-Star-VX is a C library designed to manage volume elements, called voxels,
-structured as a set of axis-aligned cuboids. This library knows nothing about
-the volume data it manages: it only provides data structures that partition
-the voxels according to the user's criteria. It also implements efficient
-operators for indexing voxels in space partitioning data structures or for
-accessing them by ray tracing.
-
-Star-VX offers 2 hierarchical data structures: the *octree* and the *binary
-tree*. The former is used to structure regular 3D data, while the latter is
-used for 1D data. Star-VX builds the required data structure following a
-bottom-up strategy: the user submits the data set to be partitioned, as well as
-the policy used to define when voxels can be merged, and the merge operator
-itself. The way in which data is accessed by *indexing* or *ray tracing* can
-also be finely tuned by the user: in addition to the position of the probe or
-the radius to be traced, he can provide callbacks to stop traversal at a
-hierarchical level that is not a leaf, perform calculations at the traversed
-leaf level, reject leaves, and so on. The host application thus has total
+Star-VX is a C library designed to manage volume elements, called
+voxels, structured as a set of axis-aligned cuboids. This library knows
+nothing about the volume data it manages: it only provides data
+structures that partition the voxels according to the user's criteria.
+It also implements efficient operators for indexing voxels in space
+partitioning data structures or for accessing them by ray tracing.
+
+Star-VX offers 2 hierarchical data structures: the *octree* and the
+*binary tree*. The former is used to structure regular 3D data, while
+the latter is used for 1D data. Star-VX builds the required data
+structure following a bottom-up strategy: the user submits the data set
+to be partitioned, as well as the policy used to define when voxels can
+be merged, and the merge operator itself. The way in which data is
+accessed by *indexing* or *ray tracing* can also be finely tuned by the
+user: in addition to the position of the probe or the radius to be
+traced, he can provide callbacks to stop traversal at a hierarchical
+level that is not a leaf, perform calculations at the traversed leaf
+level, reject leaves, and so on. The host application thus has total
control over the traversal of the data structure, while its in-memory
-representation and accessors are still entirely managed internally by Star-VX.
+representation and accessors are still entirely managed internally by
+Star-VX.
## Requirements
@@ -37,27 +39,28 @@ Edit config.mk as needed, then run:
### Version 0.2.1
-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.2
- Update the profile of the functors invoked on node traversal: the ray
origin, direction and range are now provided as input arguments.
-- Force the invocation of the challenge and filter functors on the root node.
- Previously these functors were not called on the root;the challenging and
- filtering was starting on its children.
+- Force the invocation of the challenge and filter functors on the root
+ node. Previously these functors were not called on the root;the
+ challenging and filtering was starting on its children.
### Version 0.1
-- Add the `svx_tree_write` and the `svx_tree_create_from_stream` functions used
- to serialize and de-serialize the tree data structure, respectively.
+- Add the `svx_tree_write` and the `svx_tree_create_from_stream`
+ functions used to serialize and de-serialize the tree data structure,
+ respectively.
## License
Copyright (C) 2018, 2020-2023 |Méso|Star> (contact@meso-star.com)
Copyright (C) 2018 Université Paul Sabatier
-Star-VX 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.
+Star-VX 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.
