Skip to content

Commit

Permalink
[doc] Minor corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
Wentzell committed Oct 29, 2019
1 parent ee8ac52 commit 5be40ab
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions doc/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Installation steps

#. Compile the code, run the tests and install the application::

$ make
$ make test
$ make install

Expand All @@ -48,7 +49,7 @@ To use a particular version, go into the directory with the sources, and look at

Checkout the version of the code that you want::

$ git checkout 2.1.0
$ git checkout 2.2.0

and follow steps 2 to 4 above to compile the code.

Expand All @@ -59,14 +60,14 @@ The compilation of ``w2dynamics_interface`` can be configured using CMake-option

cmake ../w2dynamics_interface.src -DOPTION1=value1 -DOPTION2=value2 ... ../w2dynamics_interface.src

+-----------------------------------------------------------------+-----------------------------------------------+
| Options | Syntax |
+=================================================================+===============================================+
+-----------------------------------------------------------------+----------------------------------------------------------+
| Options | Syntax |
+=================================================================+==========================================================+
| Specify an installation path other than path_to_triqs | -DCMAKE_INSTALL_PREFIX=path_to_w2dynamics_interface |
+-----------------------------------------------------------------+-----------------------------------------------+
| Build in Debugging Mode | -DCMAKE_BUILD_TYPE=Debug |
+-----------------------------------------------------------------+-----------------------------------------------+
| Disable testing (not recommended) | -DBuild_Tests=OFF |
+-----------------------------------------------------------------+-----------------------------------------------+
| Build the documentation | -DBuild_Documentation=ON |
+-----------------------------------------------------------------+-----------------------------------------------+
+-----------------------------------------------------------------+----------------------------------------------------------+
| Build in Debugging Mode | -DCMAKE_BUILD_TYPE=Debug |
+-----------------------------------------------------------------+----------------------------------------------------------+
| Disable testing (not recommended) | -DBuild_Tests=OFF |
+-----------------------------------------------------------------+----------------------------------------------------------+
| Build the documentation | -DBuild_Documentation=ON |
+-----------------------------------------------------------------+----------------------------------------------------------+

0 comments on commit 5be40ab

Please sign in to comment.