summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2020-03-05 14:24:01 +0100
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2020-03-05 14:24:01 +0100
commitf78d65f0bd6aaf5f92639e2b809e1711acf929f7 (patch)
tree42272a2d27eea45735b806ce46e61c41b1f5ea9a /README.md
parent73ad191a7dee054a58e9823c84dce9f1e71995f4 (diff)
parentd2943b9e7311c8a3d8a4fb379c39b15497481b9c (diff)
Merge branch 'master' into print_warnings_to_stderr
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/).