diff options
author | Gard Spreemann <gspreemann@gmail.com> | 2018-06-15 12:34:03 +0200 |
---|---|---|
committer | Gard Spreemann <gspreemann@gmail.com> | 2018-06-15 12:34:03 +0200 |
commit | 41482b4260b4aff3d6803e340d5c94fbefb9af67 (patch) | |
tree | 89eae43dcb3fd4ab040e96f3d5479427d8cd2c7f /cython/doc/installation.rst | |
parent | 41a1b8c2728e212c832c0384c8bb424139a247cf (diff) | |
parent | c524232f734de875d69e2f190f01a6c976024368 (diff) |
Merge branch 'upstream/latest' into dfsg/latest
Diffstat (limited to 'cython/doc/installation.rst')
-rw-r--r-- | cython/doc/installation.rst | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/cython/doc/installation.rst b/cython/doc/installation.rst index c182f176..43ff85c5 100644 --- a/cython/doc/installation.rst +++ b/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 ============= |