Skip to content

Commit

Permalink
Update build documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
rcurtin committed Aug 25, 2016
1 parent 62a7f8d commit bd6a79a
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 12 additions & 0 deletions doc/guide/build.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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:
@code
$ sudo apt-get install libmlpack-dev
@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
Expand Down

0 comments on commit bd6a79a

Please sign in to comment.