Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 929 Bytes

INSTALL.md

File metadata and controls

39 lines (26 loc) · 929 Bytes
Raw

Installation

Rhea is built using CMake. To keep the source tree clean, it is a good idea to build it in a separate directory:

  • mkdir build; cd build
  • cmake ..
  • make
  • sudo make install

This will install it to /usr/local. Changing this is easiest using ccmake, or one of the graphical user interfaces for CMake. To build project files for IDEs, please refer to the CMake documentation.

Running the unit tests

To run the unit and performance tests, you need to have the Boost Unit Test framework installed.

  • cmake .. -DBUILD_UNITTESTS=1
  • make
  • cd unit_tests
  • ./unit_tests
  • ./speed_test

Generating documentation

Documentation can be autogenerated using Doxygen.

  • cmake .. -DBUILD_DOCUMENTATION=1
  • make doc

The documentation ends up in the doc directory.