diff options
author | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2019-08-20 17:05:13 +0200 |
---|---|---|
committer | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2019-08-20 17:05:13 +0200 |
commit | 87a8d7962ea13f11e591462ec5757e9e1747dc07 (patch) | |
tree | 5f1ca83e20cec1be410b119622177d2a3b5ae043 /src/common/doc | |
parent | ed59f5bf1b35269cf4324dbb72df863bf50dac01 (diff) |
Fix issue #10 and modify main and installation documentations accordingly
Diffstat (limited to 'src/common/doc')
-rw-r--r-- | src/common/doc/installation.h | 12 | ||||
-rw-r--r-- | src/common/doc/main_page.md | 6 |
2 files changed, 9 insertions, 9 deletions
diff --git a/src/common/doc/installation.h b/src/common/doc/installation.h index 2629d12c..02d3c73a 100644 --- a/src/common/doc/installation.h +++ b/src/common/doc/installation.h @@ -60,8 +60,8 @@ make doxygen * Having GMP version 4.2 or higher installed is recommended. * * \subsection cgal CGAL - * The \ref alpha_complex data structure, \ref bottleneck_distance, and few examples requires CGAL, which is a C++ - * library which provides easy access to efficient and reliable geometric algorithms. + * Some GUDHI modules (cf. \ref main_page "modules list"), and few examples requires CGAL, a C++ library that provides + * easy access to efficient and reliable geometric algorithms. * * \note There is no need to install CGAL, you can just <CODE>cmake . && make</CODE> CGAL (or even * <CODE>cmake -DCGAL_HEADER_ONLY=ON .</CODE>), thereafter you will be able to compile @@ -125,13 +125,13 @@ make doxygen * \li <a href="_alpha_complex_2alpha_complex_3d_persistence_8cpp-example.html"> * Alpha_complex/alpha_complex_3d_persistence.cpp</a> * - * \subsection eigen3 Eigen3 + * \subsection eigen Eigen * The \ref alpha_complex data structure and few examples requires - * <a target="_blank" href="http://eigen.tuxfamily.org/">Eigen3</a> is a C++ template library for linear algebra: + * <a target="_blank" href="http://eigen.tuxfamily.org/">Eigen</a> is a C++ template library for linear algebra: * matrices, vectors, numerical solvers, and related algorithms. * - * The following examples/utilities require the <a target="_blank" href="http://eigen.tuxfamily.org/">Eigen3</a> and will not be - * built if Eigen3 is not installed: + * The following examples/utilities require the <a target="_blank" href="http://eigen.tuxfamily.org/">Eigen</a> and will not be + * built if Eigen is not installed: * \li <a href="_alpha_complex_2_alpha_complex_from_off_8cpp-example.html"> * Alpha_complex/Alpha_complex_from_off.cpp</a> * \li <a href="_alpha_complex_2_alpha_complex_from_points_8cpp-example.html"> diff --git a/src/common/doc/main_page.md b/src/common/doc/main_page.md index ea2474be..d8cbf97f 100644 --- a/src/common/doc/main_page.md +++ b/src/common/doc/main_page.md @@ -50,7 +50,7 @@ <b>Author:</b> Vincent Rouvreau<br> <b>Introduced in:</b> GUDHI 1.3.0<br> <b>Copyright:</b> MIT [(GPL v3)](../../licensing/)<br> - <b>Requires:</b> \ref eigen3 and \ref cgal ≥ 4.11.0 + <b>Requires:</b> \ref eigen ≥ 3.1.0 and \ref cgal ≥ 4.11.0 </td> </tr> <tr> @@ -126,7 +126,7 @@ <b>Author:</b> Siargey Kachanovich<br> <b>Introduced in:</b> GUDHI 1.3.0<br> <b>Copyright:</b> MIT ([GPL v3](../../licensing/) for Euclidean version)<br> - <b>Euclidean version requires:</b> \ref eigen3 and \ref cgal ≥ 4.11.0 + <b>Euclidean version requires:</b> \ref eigen ≥ 3.1.0 and \ref cgal ≥ 4.11.0 </td> </tr> <tr> @@ -324,7 +324,7 @@ <b>Author:</b> Clément Jamin<br> <b>Introduced in:</b> GUDHI 2.0.0<br> <b>Copyright:</b> MIT [(GPL v3)](../../licensing/)<br> - <b>Requires:</b> \ref eigen3 and \ref cgal ≥ 4.11.0 + <b>Requires:</b> \ref eigen ≥ 3.1.0 and \ref cgal ≥ 4.11.0 </td> </tr> <tr> |