Skip to content

Commit

Permalink
Documentation++ (#219)
Browse files Browse the repository at this point in the history
  • Loading branch information
henricasanova committed Feb 4, 2021
1 parent 447fa90 commit d3f52bd
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions doc/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ And, one of the following:

## Optional Dependencies ## {#install-prerequisites-opt-dependencies}

- [Google Test](https://github.com/google/googletest) -- version 1.8 or higher (only required for running test cases)
- [Google Test](https://github.com/google/googletest) -- version 1.8 or higher (only required for running tests)
- [Doxygen](http://www.doxygen.org) -- version 1.8 or higher (only required for generating documentation)
- [Batsched](https://gitlab.inria.fr/batsim/batsched) -- only needed for realistic simulation of compute resources managed by production batch schedulers

Expand All @@ -32,7 +32,8 @@ And, one of the following:
## Building WRENCH ## {#install-source-build}

You can download the _@WRENCHRelease.tar.gz_ archive from the
[GitHub releases](https://github.com/wrench-project/wrench/releases) page and install it as follows:
[GitHub releases](https://github.com/wrench-project/wrench/releases) page. Once you have
installed dependencies (see above), you can install WRENCH as follows:

~~~~~~~~~~~~~{.sh}
tar xf @WRENCHRelease.tar.gz
Expand Down Expand Up @@ -70,13 +71,18 @@ make unit_tests

## Installation Troubleshooting ## {#install-troubleshooting}

##### `Could NOT find PkgConfig (missing: PKG_CONFIG_EXECUTABLE)`
#### Could NOT find PkgConfig (missing: PKG_CONFIG_EXECUTABLE)

- This error on MacOS is because the `pkg-config` package is not installed
- Solution: install this package
- MacPorts: `sudo port install pkg-config`
- Brew: `sudo brew install pkg-config`

#### Could not find libgfortran when building the SimGrid dependency

- This is an error that sometimes occurs on MacOS
- A quick fix is to disable the SMPI feature of SimGrid when configuring it: `cmake -Denable_smpi=off .`

# Docker Containers # {#install-docker}

WRENCH is also distributed in Docker containers. Please, visit the
Expand Down

0 comments on commit d3f52bd

Please sign in to comment.