git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/Nerve_GIC@2838 636b058d-ea47-450e-bf9e-a15bfbe3eedb

Former-commit-id: aa674c458f110c5c7cc3f5c987b921fcc96e3e7e

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 !!