diff --git a/README.md b/README.md index 5010e4b4..789ecf65 100644 --- a/README.md +++ b/README.md @@ -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-"], + "cacheVariables": { + "CMAKE_BUILD_TYPE": "Debug" + } + } + ], + "buildPresets": [ + { + "name": "dev", + "configurePreset": "dev", + "configuration": "Debug" + } + ], + "testPresets": [ + { + "name": "dev", + "configurePreset": "dev", + "configuration": "Debug", + "output": { + "outputOnFailure": true + } + } + ] +} +``` +Replace `` in the `CmakeUserPresets.json` file with the name of +the operating system you have (`win64`, `linux` or `darwin`). ### Configure, build and test