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

Jump to bottom

Add cmake presets #435

Merged
merged 4 commits into from
Aug 22, 2024
Merged

Add cmake presets #435

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
013ad67
Add cmake presets
fsimonis Jul 26, 2024
af8a26d
FIx typo
fsimonis Aug 22, 2024
0381fef
Reword directory
fsimonis Aug 22, 2024
e9b1779
Update pages/docs/installation/installation-source-configuration.md
MakisH Aug 22, 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
20 changes: 20 additions & 0 deletions pages/docs/installation/installation-source-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,26 @@ keywords: configuration, basics, cmake, installation, building, source
preCICE uses [CMake](https://cmake.org/) to configure and build the library.
After this step, preCICE is ready to [be built](installation-source-building).

## Using presets

preCICE offers a range of CMake configuration presets, which all use the build directory `build`.
MakisH marked this conversation as resolved.
Show resolved Hide resolved

To see all available presets use:

```bash
cd precice-{{ site.precice_version }} # Enter the preCICE source directory
cmake --list-presets
```

The to configure preCICE, run:
fsimonis marked this conversation as resolved.
Show resolved Hide resolved

```bash
cd precice-{{ site.precice_version }} # Enter the preCICE source directory
cmake --preset=production # Configure using the production preset
```

This will automatically create a build directory for you.
fsimonis marked this conversation as resolved.
Show resolved Hide resolved

## Build directory

CMake keeps track of the source and the build directory separately.
Expand Down
Loading