summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2020-02-26 09:32:49 +0100
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2020-02-26 09:32:49 +0100
commit571cf3f3087f84a251e3029ffe357cc4434528d1 (patch)
tree940695d728ffdda271ee952f867a51f2ff7834a2 /README.md
parentcbb350d81a8c4acadf31b604aaebde209f462e55 (diff)
parent63e4222e528317b7e0385bf5881393ff2f97fa80 (diff)
Merge branch 'master' into iterator_over_simplex_tree
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index 167a38b3..f7e3d70c 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,15 @@
The GUDHI library is a generic open source C++ library, with a Python interface, for Topological Data Analysis (TDA) and Higher Dimensional Geometry Understanding. The library offers state-of-the-art data structures and algorithms to construct simplicial complexes and compute persistent homology.
+# Source code
+
+We recommend that users get official releases from [the GUDHI website](https://gudhi.inria.fr/).
+
+For potential contributors, to fully checkout GUDHI, after cloning the git repository, you may also need to checkout its submodules using
+```sh
+git submodule update --init
+```
+
# Compilation and installation
To install GUDHI, you can follow the [C++ compilation procedure](https://gudhi.inria.fr/doc/latest/installation.html), the [Python compilation procedure](https://gudhi.inria.fr/python/latest/installation.html), use our [conda-forge package](https://gudhi.inria.fr/conda/), or [go with Docker](https://gudhi.inria.fr/dockerfile/).