blob: 4f717e9c21662d90f08b13dbbc1ff5efc63771c3 [file] [log] [blame]
Benoit Jacobd040c9f2009-10-03 17:19:14 -04001Installation instructions for Eigen
2***********************************
3
4Explanation before starting
5***************************
6
Benoit Jacobb78b2ed2009-10-04 20:27:44 -04007Eigen consists only of header files, hence there is nothing to compile
8before you can use it. Moreover, these header files do not depend on your
9platform, they are the same for everybody.
Benoit Jacobd040c9f2009-10-03 17:19:14 -040010
11Method 1. Installing without using CMake
12****************************************
13
14You can use right away the headers in the Eigen/ subdirectory. In order
15to install, just copy this Eigen/ subdirectory to your favorite location.
Benoit Jacob7956fc42009-10-03 22:11:30 -040016If you also want the unsupported features, copy the unsupported/
17subdirectory too.
Benoit Jacobd040c9f2009-10-03 17:19:14 -040018
19Method 2. Installing using CMake
20********************************
21
Benoit Jacob7956fc42009-10-03 22:11:30 -040022Let's call this directory 'source_dir' (where this INSTALL file is).
23Before starting, create another directory which we will call 'build_dir'.
Benoit Jacobd040c9f2009-10-03 17:19:14 -040024
25Do:
26
27 cd build_dir
28 cmake source_dir
29 make install
30
31The "make install" step may require administrator privileges.
32
33You can adjust the installation destination (the "prefix")
34by passing the -DCMAKE_INSTALL_PREFIX=myprefix option to cmake, as is
35explained in the message that cmake prints at the end.