diff options
author | Benoit Jacob <jacob.benoit.1@gmail.com> | 2009-10-03 17:19:14 -0400 |
---|---|---|
committer | Benoit Jacob <jacob.benoit.1@gmail.com> | 2009-10-03 17:19:14 -0400 |
commit | d040c9fc9e174dfd2b3d2b0171347b03a86f689a (patch) | |
tree | 9b662a7e73c18d4969fa374f396a9d3cd143d475 /INSTALL | |
parent | a1d9b76dd54679bf0e2f6ac2faca27b7417c6bdd (diff) |
add INSTALL and message about no need to do "make"
Diffstat (limited to 'INSTALL')
-rw-r--r-- | INSTALL | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL new file mode 100644 index 000000000..5cc57bd1b --- /dev/null +++ b/INSTALL @@ -0,0 +1,37 @@ +Installation instructions for Eigen +*********************************** + +Explanation before starting +*************************** + +It is very important to understand than Eigen consists only of header files, +hence there is nothing to compile before you can use it. Moreover, these +header files do not depend on your platform, they are the same for +everybody. + + +Method 1. Installing without using CMake +**************************************** + +You can use right away the headers in the Eigen/ subdirectory. In order +to install, just copy this Eigen/ subdirectory to your favorite location. +If you also want the unsupported features, also copy the unsupported/ +subdirectory. + +Method 2. Installing using CMake +******************************** + +Let's call this directory 'source_dir'. Before starting, create another +directory which we will call 'build_dir'. + +Do: + + cd build_dir + cmake source_dir + make install + +The "make install" step may require administrator privileges. + +You can adjust the installation destination (the "prefix") +by passing the -DCMAKE_INSTALL_PREFIX=myprefix option to cmake, as is +explained in the message that cmake prints at the end. |