Merge pull request #20 from lbl-cbg/up_cmake_readme

Add description how to set -Daq-nwb_DEVELOPER_MODE=ON
NeurodataWithoutBorders · Apr 19, 2024 · c8239d8 · c8239d8
2 parents 2ec960a + f3930bb
commit c8239d8
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -34,7 +34,12 @@ cmake --install build --config Release
 
 Build system targets that are only useful for developers of this project are
 hidden if the `aq-nwb_DEVELOPER_MODE` option is disabled. Enabling this
-option makes tests and other developer targets and options available.
+option makes tests and other developer targets and options available. You can enable
+the option when configuring the build by adding ``-Daq-nwb_DEVELOPER_MODE=ON``, e.g.,:
+
+```sh
+cmake -S . -B build -Daq-nwb_DEVELOPER_MODE=ON
+```
 
 ### Configure, build and test