INSTALL.txt

Dependencies:
-------------

 * Eigen3, a C++ template library for linear algebra:

   http://eigen.tuxfamily.org/
   
   Debian/Ubuntu package:  libeigen3-dev
   Red Hat/Fedora package:  eigen3-devel
   
 * CMake version 2.8.9 or newer, to generate the build files:
 
   http://cmake.org/
   
   Debian/Ubuntu package:  cmake
   Red Hat/Fedora package:  cmake
   
 * Optionally Doxygen, to generate the documentation:
 
   http://www.stack.nl/~dimitri/doxygen/
   
   Debian/Ubuntu package:  doxygen
   Red Hat/Fedora package:  doxygen
   

Installation:
-------------

 * Run CMake to generate the build files.
 
   UNIX:
   
     Inside the Vortexje source folder, run:
   
     mkdir build && cd build && cmake ..

 * Build Vortexje using the chosen build system.
 
   UNIX:
   
     make
 
See the following website for details on the CMake build process:

  http://www.cmake.org/cmake/help/runningcmake.html