Skip to content

Commit

Permalink
update README to include dev preset info
Browse files Browse the repository at this point in the history
  • Loading branch information
stephprince committed Aug 5, 2024
1 parent b32debd commit e910f23
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,50 @@ the option when configuring the build by adding ``-Daq-nwb_DEVELOPER_MODE=ON``,
```sh
cmake -S . -B build -Daq-nwb_DEVELOPER_MODE=ON
```
### Presets

As a developer, you can create your own dev preset by making a `CMakeUserPresets.json` file at the root of
the project:

```json
{
"version": 2,
"cmakeMinimumRequired": {
"major": 3,
"minor": 15,
"patch": 0
},
"configurePresets": [
{
"name": "dev",
"binaryDir": "${sourceDir}/build/dev",
"inherits": ["dev-mode", "ci-<os>"],
"cacheVariables": {
"CMAKE_BUILD_TYPE": "Debug"
}
}
],
"buildPresets": [
{
"name": "dev",
"configurePreset": "dev",
"configuration": "Debug"
}
],
"testPresets": [
{
"name": "dev",
"configurePreset": "dev",
"configuration": "Debug",
"output": {
"outputOnFailure": true
}
}
]
}
```
Replace `<os>` in the `CmakeUserPresets.json` file with the name of
the operating system you have (`win64`, `linux` or `darwin`).

### Configure, build and test

Expand Down

0 comments on commit e910f23

Please sign in to comment.