xref: /aosp_15_r20/external/eigen/INSTALL (revision bf2c37156dfe67e5dfebd6d394bad8b2ab5804d4)
1*bf2c3715SXin LiInstallation instructions for Eigen
2*bf2c3715SXin Li***********************************
3*bf2c3715SXin Li
4*bf2c3715SXin LiExplanation before starting
5*bf2c3715SXin Li***************************
6*bf2c3715SXin Li
7*bf2c3715SXin LiEigen consists only of header files, hence there is nothing to compile
8*bf2c3715SXin Libefore you can use it. Moreover, these header files do not depend on your
9*bf2c3715SXin Liplatform, they are the same for everybody.
10*bf2c3715SXin Li
11*bf2c3715SXin LiMethod 1. Installing without using CMake
12*bf2c3715SXin Li****************************************
13*bf2c3715SXin Li
14*bf2c3715SXin LiYou can use right away the headers in the Eigen/ subdirectory. In order
15*bf2c3715SXin Lito install, just copy this Eigen/ subdirectory to your favorite location.
16*bf2c3715SXin LiIf you also want the unsupported features, copy the unsupported/
17*bf2c3715SXin Lisubdirectory too.
18*bf2c3715SXin Li
19*bf2c3715SXin LiMethod 2. Installing using CMake
20*bf2c3715SXin Li********************************
21*bf2c3715SXin Li
22*bf2c3715SXin LiLet's call this directory 'source_dir' (where this INSTALL file is).
23*bf2c3715SXin LiBefore starting, create another directory which we will call 'build_dir'.
24*bf2c3715SXin Li
25*bf2c3715SXin LiDo:
26*bf2c3715SXin Li
27*bf2c3715SXin Li  cd build_dir
28*bf2c3715SXin Li  cmake source_dir
29*bf2c3715SXin Li  make install
30*bf2c3715SXin Li
31*bf2c3715SXin LiThe "make install" step may require administrator privileges.
32*bf2c3715SXin Li
33*bf2c3715SXin LiYou can adjust the installation destination (the "prefix")
34*bf2c3715SXin Liby passing the -DCMAKE_INSTALL_PREFIX=myprefix option to cmake, as is
35*bf2c3715SXin Liexplained in the message that cmake prints at the end.
36