diff options
| author | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2018-07-02 09:46:08 +0000 |
|---|---|---|
| committer | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2018-07-02 09:46:08 +0000 |
| commit | 9d1e8bcf6ee35b25a3e02b47a30a0b3cda89461d (patch) | |
| tree | 9d8eb7e1bf90e8dcc4c3212cfe28312846391809 /src/cython/doc/installation.rst | |
| parent | 4006d0f51dea0bf4234fbdc62b35fe71562293d8 (diff) | |
| parent | 34d50c272e468e3cf39d18c7e43730274d936acd (diff) | |
Merge last trunk modifications
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/python_nerve_gic_vincent@3656 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: 1f02e2f3b3e716d6578be49437e7d0b33fa99e5b
Diffstat (limited to 'src/cython/doc/installation.rst')
| -rw-r--r-- | src/cython/doc/installation.rst | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/src/cython/doc/installation.rst b/src/cython/doc/installation.rst index c182f176..43ff85c5 100644 --- a/src/cython/doc/installation.rst +++ b/src/cython/doc/installation.rst @@ -1,12 +1,16 @@ +:orphan: + +.. To get rid of WARNING: document isn't included in any toctree + Installation ############ Compiling ********* - -The library uses c++11 and requires `Boost <http://www.boost.org/>`_ with -version 1.48.0 or more recent. It is a multi-platform library and compiles on -Linux, Mac OSX and Visual Studio 2015. +The library uses c++11 and requires `Boost <https://www.boost.org/>`_ ≥ 1.48.0 +and `CMake <https://www.cmake.org/>`_ ≥ 3.1. +It is a multi-platform library and compiles on Linux, Mac OSX and Visual +Studio 2015. It also requires cmake to generate makefiles, and cython to compile the library. @@ -43,6 +47,9 @@ following command in a terminal: export PYTHONPATH='$PYTHONPATH:/path-to-gudhi/build/cython' ctest -R py_test +If tests fail, please try to :code:`import gudhi` and check the errors. +The problem can come from a third-party library bad link or installation. + Documentation ============= |