[mlpack-git] master: Update build documentation. (bd6a79a)

gitdub at mlpack.org gitdub at mlpack.org
Thu Aug 25 14:50:16 EDT 2016


Repository : https://github.com/mlpack/mlpack
On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/62a7f8db54f214b1ed75ea86b8162907985f1fd2...bd6a79a2cb744c5fa94c2ed04b2bd1d17d409de6

>---------------------------------------------------------------

commit bd6a79a2cb744c5fa94c2ed04b2bd1d17d409de6
Author: Ryan Curtin <ryan at ratml.org>
Date:   Thu Aug 25 14:50:16 2016 -0400

    Update build documentation.


>---------------------------------------------------------------

bd6a79a2cb744c5fa94c2ed04b2bd1d17d409de6
 README.md           | 13 +++++++++++--
 doc/guide/build.hpp | 12 ++++++++++++
 2 files changed, 23 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index d5d1647..45f419b 100644
--- a/README.md
+++ b/README.md
@@ -71,8 +71,17 @@ If you are compiling Armadillo by hand, ensure that LAPACK and BLAS are enabled.
 4. Building mlpack from source
 ------------------------------
 
-(see also [Building mlpack From Source](http://www.mlpack.org/docs/mlpack-git/doxygen.php?doc=build.html))
-(see also [Building mlpack Under Windows](https://github.com/mlpack/mlpack/wiki/WindowsBuild))
+This section discusses how to build mlpack from source.  However, mlpack is in
+the repositories of many Linux distributions and so it may be easier to use the
+package manager for your system.  For example, on Ubuntu, you can install mlpack
+with the following command:
+
+    $ sudo apt-get install libmlpack-dev
+
+There are some other useful pages to consult in addition to this section:
+
+  - [Building mlpack From Source](http://www.mlpack.org/docs/mlpack-git/doxygen.php?doc=build.html)
+  - [Building mlpack Under Windows](https://github.com/mlpack/mlpack/wiki/WindowsBuild)
 
 mlpack uses CMake as a build system and allows several flexible build
 configuration options. One can consult any of numerous CMake tutorials for
diff --git a/doc/guide/build.hpp b/doc/guide/build.hpp
index f3b0cad..d62a12a 100644
--- a/doc/guide/build.hpp
+++ b/doc/guide/build.hpp
@@ -2,6 +2,18 @@
 
 @section buildintro Introduction
 
+This document discusses how to build mlpack from source.  However, mlpack is in
+the repositories of many Linux distributions and so it may be easier to use the
+package manager for your system.  For example, on Ubuntu, you can install mlpack
+with the following command:
+
+ at code
+$ sudo apt-get install libmlpack-dev
+ at endcode
+
+If mlpack is not available in your system's package manager, then you can follow
+this document for how to compile and install mlpack from source.
+
 mlpack uses CMake as a build system and allows several flexible build
 configuration options.  One can consult any of numerous CMake tutorials for
 further documentation, but this tutorial should be enough to get mlpack built




More information about the mlpack-git mailing list