summaryrefslogtreecommitdiff
path: root/src/common/utilities
diff options
context:
space:
mode:
Diffstat (limited to 'src/common/utilities')
-rw-r--r--src/common/utilities/README19
-rw-r--r--src/common/utilities/off_file_from_shape_generator.cpp2
-rw-r--r--src/common/utilities/pointsetgenerator.md39
3 files changed, 40 insertions, 20 deletions
diff --git a/src/common/utilities/README b/src/common/utilities/README
deleted file mode 100644
index 18fa8cc4..00000000
--- a/src/common/utilities/README
+++ /dev/null
@@ -1,19 +0,0 @@
-# Pointset generator #
-
-## `off_file_from_shape_generator` ##
-
-Generates a pointset and save it in an OFF file. Command-line is:
-`off_file_from_shape_generator on|in sphere|cube|curve|torus|klein <filename> <num_points> <dimension> <parameter1> <parameter2>...`
-
-Warning: "on cube" generator is not available!
-
-Examples:
-
-* Generate an onSphere.off file with 1000 points randomized on a sphere of dimension 3 and radius 15.2:
-`off_file_from_shape_generator on sphere onSphere.off 1000 3 15.2`
-
-* Generate an 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 sphere inSphere.off 100 2`
-
-* Generates a inCube.off file with 10000 points randomized in a cube of dimension 3 and side 5.8:
-`off_file_from_shape_generator in cube inCube.off 10000 3 5.8`
diff --git a/src/common/utilities/off_file_from_shape_generator.cpp b/src/common/utilities/off_file_from_shape_generator.cpp
index afcd558c..5e3da7f7 100644
--- a/src/common/utilities/off_file_from_shape_generator.cpp
+++ b/src/common/utilities/off_file_from_shape_generator.cpp
@@ -4,7 +4,7 @@
*
* Author(s): Vincent Rouvreau
*
- * Copyright (C) 2014 INRIA Saclay (France)
+ * Copyright (C) 2014 Inria
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/src/common/utilities/pointsetgenerator.md b/src/common/utilities/pointsetgenerator.md
new file mode 100644
index 00000000..c8c819b7
--- /dev/null
+++ b/src/common/utilities/pointsetgenerator.md
@@ -0,0 +1,39 @@
+---
+layout: page
+title: "OFF point set generator"
+meta_title: "OFF point set generator"
+teaser: ""
+permalink: /pointsetgenerator/
+---
+{::comment}
+Leave the lines above as it is required by the web site generator 'Jekyll'
+{:/comment}
+
+
+Generates a pointset and save it in an OFF file. Command-line is:
+
+```
+off_file_from_shape_generator on|in sphere|cube|curve|torus|klein <filename> <num_points> <dimension> <parameter1> <parameter2>...
+```
+
+Warning: "on cube" generator is not available!
+
+**Examples**
+
+```
+off_file_from_shape_generator on sphere onSphere.off 1000 3 15.2
+```
+
+* Generates an 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 an 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.