Document utilies in README files using Markdown + move/rename some utilities

Only missing doc for now: Garland_heckbert

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

Former-commit-id: 7ba0113762b6622130835dc9e372acfae29c2db8

1 files changed, 19 insertions, 0 deletions

diff --git a/src/Bottleneck_distance/utilities/README b/src/Bottleneck_distance/utilities/README
new file mode 100644
index 00000000..4c9b0735
--- /dev/null
+++ b/src/Bottleneck_distance/utilities/README
@@ -0,0 +1,19 @@
+# Bottleneck_distance #

+

+## `alpha_rips_persistence_bottleneck_distance` ##

+This program computes the persistent homology with coefficient field Z/pZ of a Rips complex defined on a set of input points. The output diagram contains one bar per line, written with the convention:

+

+`p dim b d`

+

+where `dim` is the dimension of the homological feature, `b` and `d` are respectively the birth and death of the feature, and `p` is the characteristic of the field *Z/pZ* used for homology coefficients.

+

+Usage:

+`alpha_rips_persistence_bottleneck_distance [options] <OFF input file>`

+

+Allowed options:

+

+* `-h [ --help ]` Produce help message

+* `-r [ --max-edge-length ]` (default = inf) Maximal length of an edge for the Rips complex construction.`

+* `-d [ --cpx-dimension ]` (default = 1) Maximal dimension of the Rips complex we want to compute.`

+* `-p [ --field-charac ]` (default = 11)     Characteristic p of the coefficient field Z/pZ for computing homology.

+* `-m [ --min-persistence ]` (default = 0) Minimal lifetime of homology feature to be recorded. Enter a negative value to see zero length intervals.
\ No newline at end of file