summaryrefslogtreecommitdiff
path: root/src/common/utilities/README
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-05-30 09:01:34 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-05-30 09:01:34 +0000
commit7035590cdfd71eb7454d638f3b479d62a0ebadf4 (patch)
tree22c52add59351ccc735e50aa7f2c60bad4459780 /src/common/utilities/README
parenta2b61958106a0d94fa86aa146b62caef78b62afa (diff)
parenta1423daa252b40aa715ce9b83087e02c4f1d2a1d (diff)
Merge cmake_modules_for_gudhi branch in trunk
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@2469 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: a7ae351317d741b2657b0fcde335393fbdfc1630
Diffstat (limited to 'src/common/utilities/README')
-rw-r--r--src/common/utilities/README19
1 files changed, 19 insertions, 0 deletions
diff --git a/src/common/utilities/README b/src/common/utilities/README
new file mode 100644
index 00000000..dc841521
--- /dev/null
+++ b/src/common/utilities/README
@@ -0,0 +1,19 @@
+======================= off_file_from_shape_generator ==================================
+
+Example of use :
+
+*** on|in sphere|cube|curve|torus|klein generator
+
+./off_file_from_shape_generator on sphere onSphere.off 1000 3 15.2
+
+ => generates a onSphere.off file with 1000 points randomized on a sphere of dimension 3 and radius 15.2
+
+./off_file_from_shape_generator in sphere inSphere.off 100 2
+
+ => generates a inSphere.off file with 100 points randomized in a sphere of dimension 2 (circle) and radius 1.0 (default)
+
+./off_file_from_shape_generator in cube inCube.off 10000 3 5.8
+
+ => generates a inCube.off file with 10000 points randomized in a cube of dimension 3 and side 5.8
+
+!! Warning: hypegenerator on cube is not available !!