Add a use case for BUILD_SHARED_LIBS in docs

Signed-off-by: Omar Shrit <omar@shrit.me>
This commit is contained in:
Omar Shrit
2021-04-26 13:01:44 +02:00
parent 54267705ed
commit da5862bcd0
+11 -1
View File
@@ -209,6 +209,14 @@ The full list of options mlpack allows:
Each option can be specified to CMake with the '-D' flag. Other tools can also
be used to configure CMake, but those are not documented here.
For example, if you would like to build mlpack and its CLI binding statically, then
you need to execute the following commands:
@code
$ cd build
$ cmake -D BUILD_SHARED_LIBS=OFF ../
@endcode
In addition, the following directories may be specified, to find include files
and libraries. These also use the '-D' flag.
@@ -216,10 +224,12 @@ and libraries. These also use the '-D' flag.
- ARMADILLO_LIBRARY=(/path/to/armadillo/libarmadillo.so): location of Armadillo
library
- BOOST_ROOT=(/path/to/boost/): path to root of boost installation
- CEREAL_INCLUDE_DIR=(/path/to/cereal/include): path to include directory for
cereal
- ENSMALLEN_INCLUDE_DIR=(/path/to/ensmallen/include): path to include directory
for ensmallen
- STB_IMAGE_INCLUDE_DIR=(/path/to/stb/include): path to include directory for
STB image library
STB image library
- MATHJAX_ROOT=(/path/to/mathjax): path to root of MathJax installation
@section build_build Building mlpack