Merged in f5soh/librepilot/update_credits (pull request #529)
[librepilot.git] / ground / gcs / src / libs / eigen / INSTALL
blob4f717e9c21662d90f08b13dbbc1ff5efc63771c3
1 Installation instructions for Eigen
2 ***********************************
4 Explanation before starting
5 ***************************
7 Eigen consists only of header files, hence there is nothing to compile
8 before you can use it. Moreover, these header files do not depend on your
9 platform, they are the same for everybody.
11 Method 1. Installing without using CMake
12 ****************************************
14 You can use right away the headers in the Eigen/ subdirectory. In order
15 to install, just copy this Eigen/ subdirectory to your favorite location.
16 If you also want the unsupported features, copy the unsupported/
17 subdirectory too.
19 Method 2. Installing using CMake
20 ********************************
22 Let's call this directory 'source_dir' (where this INSTALL file is).
23 Before starting, create another directory which we will call 'build_dir'.
25 Do:
27   cd build_dir
28   cmake source_dir
29   make install
31 The "make install" step may require administrator privileges.
33 You can adjust the installation destination (the "prefix")
34 by passing the -DCMAKE_INSTALL_PREFIX=myprefix option to cmake, as is
35 explained in the message that cmake prints at the end.