summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authormathieu <mathieu.carriere3@gmail.com>2020-02-13 19:39:29 -0500
committermathieu <mathieu.carriere3@gmail.com>2020-02-13 19:39:29 -0500
commit5b7df6d0f6807b87ad936f7c322355de22bd516f (patch)
treeae8ee5e642c55a1177046c9f6d1c681f5f38b29c /README.md
parent266314e4f0a4c767eb2d1bcd321788dddc03320c (diff)
parentbed30b19e57669c0b8ad385f1124586ed3499a2d (diff)
Merge branch 'master' of https://github.com/GUDHI/gudhi-devel into extended_persistence
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/).