summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2019-03-08 08:50:04 +0100
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2019-03-08 08:50:04 +0100
commit85f2f9bdd383e86130bb8a1c378484e76ffff569 (patch)
tree26ac3db1b0c4aa4002ffa3d57554a943bf0d4055 /README.md
parentd7216fffe2a7fb3b15dcb84a4d5464968ae4a436 (diff)
Use Markdown for README and add some informations
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..e5d1c382
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+![alt text](https://gudhi.inria.fr/assets/img/logo.png "GUDHI library - Topological data analysis and geometric inference in higher dimensions")
+
+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.
+
+# 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/).
+
+# More information
+
+* [The GUDHI website](https://gudhi.inria.fr/)
+* [Contact us](https://gudhi.inria.fr/contact/)
+* [Subscribe to the GUDHI users mailing list](https://gudhi.inria.fr/keepintouch/)
+* [Tutorials](https://gudhi.inria.fr/tutorials/)