summaryrefslogtreecommitdiff
path: root/src/Bottleneck_distance/utilities
diff options
context:
space:
mode:
Diffstat (limited to 'src/Bottleneck_distance/utilities')
-rw-r--r--src/Bottleneck_distance/utilities/README10
-rw-r--r--src/Bottleneck_distance/utilities/bottleneckdistance.md18
2 files changed, 18 insertions, 10 deletions
diff --git a/src/Bottleneck_distance/utilities/README b/src/Bottleneck_distance/utilities/README
deleted file mode 100644
index d9fdd252..00000000
--- a/src/Bottleneck_distance/utilities/README
+++ /dev/null
@@ -1,10 +0,0 @@
-# Bottleneck_distance #
-
-## `bottleneck_read_file_example` ##
-This program computes the Bottleneck distance between two persistence diagram files.
-
-Usage:
-`bottleneck_read_file_example <file_1.pers> <file_2.pers> [<tolerance>]`
-where
-`<file_1.pers>` and `<file_2.pers>` must be in the format described [here](http://gudhi.gforge.inria.fr/doc/latest/fileformats.html#FileFormatsPers).
-`<tolerance>` is an error bound on the bottleneck distance (set by default to the smallest positive double value).
diff --git a/src/Bottleneck_distance/utilities/bottleneckdistance.md b/src/Bottleneck_distance/utilities/bottleneckdistance.md
new file mode 100644
index 00000000..526f5822
--- /dev/null
+++ b/src/Bottleneck_distance/utilities/bottleneckdistance.md
@@ -0,0 +1,18 @@
+
+
+# Bottleneck distance #
+
+## bottleneck_read_file_example ##
+
+This program computes the Bottleneck distance between two persistence diagram files.
+
+**Usage**
+
+```
+ bottleneck_read_file_example <file_1.pers> <file_2.pers> [<tolerance>]
+```
+
+where
+
+* `<file_1.pers>` and `<file_2.pers>` must be in the format described [here](/doc/latest/fileformats.html#FileFormatsPers).
+* `<tolerance>` is an error bound on the bottleneck distance (set by default to the smallest positive double value).