Skip to content

Commit

Permalink
doc: add some example cmake options
Browse files Browse the repository at this point in the history
  • Loading branch information
ToruNiina committed Aug 18, 2021
1 parent 0871967 commit 605bba5
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions book/content.en/docs/installation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,26 @@ $ make
$ make test
```

### Example CMake Options

- To change the compiler to be used

```console
$ cmake .. -DCMAKE_CXX_COMPILER=clang++
```

- To use Boost library installed in your system

```console
$ cmake .. -DFIND_BOOST=ON -DBOOST_ROOT=/path/to/boost
```

- To speedup compilation by turning separated build on and also using pre-built boost library

```console
$ cmake .. -DSEPARATE_BUILD=ON -DFIND_BOOST=ON -DBOOST_ROOT=/path/to/boost
```

### Options for CMake

All those are optional variables.
Expand Down Expand Up @@ -98,4 +118,10 @@ All those are optional variables.
- `-DPERIODIC_BOUNDARY_SUPPORT=(ON|OFF)`
- `ON` by default.
- If `OFF`, `CuboidalPeriodicBoundary` would not be able to be used, but the compilation finishes quickly.
- `-DBUILD_UNIT_TEST=(ON|OFF)`
- `ON` by default.
- If `OFF`, unit tests would not be compiled. It will save your time.
- `-DBUILD_INTEGRATION_TEST=(ON|OFF)`
- `OFF` by default.
- If `ON`, integration tests will be compiled.

0 comments on commit 605bba5

Please sign in to comment.