Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating Documentation for FetchContent Changes #224

Merged
merged 3 commits into from
Jun 26, 2024
Merged

Updating Documentation for FetchContent Changes #224

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6b70c63
Update installation quick guide with new target name and CMakeOptions.
FlorianXXIV Jun 24, 2024
97e0e59
Clarification in CMake Options
FlorianXXIV Jun 24, 2024
6a8d969
Verified documentation working and removing unnecessary backslashes
FlorianXXIV Jun 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 30 additions & 2 deletions docs/docs/quickstart/installation/installation.md
View file
Open in desktop
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)
```
Loading