summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2019-05-22 09:33:44 +0200
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2019-05-22 09:33:44 +0200
commit2927abe9a4b00bd291703340daaaed7bf20f3753 (patch)
tree156fc741c434c41fdff7c690eb8f354d582a9ff1 /README.md
parent0e17d3cc8b89fc9fae4f358bb6a8cedaeaff6f0b (diff)
parent0c7d6ae4ddb68422e02a48b6a5575c176041d3e4 (diff)
Merge branch 'master' into simplex_tree_insert_duplicated_vertices_fix_vincent
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..6cc05ff6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+
+[![Build Status](https://travis-ci.org/GUDHI/gudhi-devel.svg?branch=master)](https://travis-ci.org/GUDHI/gudhi-devel)
+[![CircleCI](https://circleci.com/gh/GUDHI/gudhi-devel/tree/master.svg?style=svg)](https://circleci.com/gh/GUDHI/gudhi-devel/tree/master)
+
+![GUDHI](src/common/doc/Gudhi_banner.png "Topological Data Analysis (TDA) and Higher Dimensional Geometry Understanding")
+
+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/)