Skip to content

Commit

Permalink
Updating Documentation for FetchContent Changes (#224)
Browse files Browse the repository at this point in the history
* Update installation quick guide with new target name and CMakeOptions.

* Clarification in CMake Options

* Verified documentation working and removing unnecessary backslashes
  • Loading branch information
FlorianXXIV committed Jun 26, 2024
1 parent 7ef2029 commit 3aace11
Showing 1 changed file with 30 additions and 2 deletions.
32 changes: 30 additions & 2 deletions docs/docs/quickstart/installation/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,36 @@ FetchContent_Declare(
FetchContent_MakeAvailable(graaflib)
```
Now you can link your target against `Graaf_lib`:
Now you can link your target against `Graaf::Graaf`:
```CMake
target_link_libraries(${PROJECT_NAME} PRIVATE Graaf_lib)
target_link_libraries(${PROJECT_NAME} PRIVATE Graaf::Graaf)
```
## CMake Options
There are multiple CMake Options available to choose how you want to build Graaf in your Project.
- `SKIP_TESTS`
- Default: `OFF`
- Enabling skips building the tests.
- `SKIP_EXAMPLES`
- Default: `OFF`
- This skips building the example usages of the Library.
- `SKIP_BENCHMARKS`
- Default: `OFF`
- This skips building the Benchmarks.
These Options can be set while executing the cmake command
```bash
cmake -DSKIP_TESTS=ON -DSKIP_EXAMPLES=ON -DSKIP_BENCHMARKS=ON [source_directory]
```
or by setting them in your Projects CMakeLists.txt (before `FetchContent_MakeAvailable(graaflib)`)
```cmake
set(SKIP_TESTS ON)
set(SKIP_BENCHMARKS ON)
set(SKIP_EXAMPLES ON)
FetchContent_MakeAvailable(graaflib)
```

0 comments on commit 3aace11

Please sign in to comment.