diff options
| -rw-r--r-- | README | 11 | ||||
| -rw-r--r-- | README.md | 14 |
2 files changed, 14 insertions, 11 deletions
diff --git a/README b/README deleted file mode 100644 index 2bbe5d14..00000000 --- a/README +++ /dev/null @@ -1,11 +0,0 @@ -The Gudhi library is release under the GNU GENERAL PUBLIC LICENSE Version 3. A -copy of the licence may be found in the file COPYING. - - -To build the library, run in a Terminal: - -cd /path-to-gudhi/ -mkdir build -cd build/ -cmake .. -make diff --git a/README.md b/README.md new file mode 100644 index 00000000..e5d1c382 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ + + +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/) |