document default build type and give advice for how to override it

lcm-proj · May 12, 2024 · 2b7f0fc · 2b7f0fc
1 parent aa7d957
commit 2b7f0fc
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/docs/content/build-instructions.md b/docs/content/build-instructions.md
@@ -33,6 +33,14 @@ generators. To users familiar with CMake, we recommend using
 A detailed description of how to use CMake is not specific to LCM and is beyond
 the scope of these instructions.
 
+By default CMake is configured to produce a release build. To build with debug symbols instead, use:
+
+```shell
+cmake .. -DCMAKE_BUILD_TYPE=Debug
+```
+
+when configuring a build directory in the following sections.
+
 ## Ubuntu and Debian
 
 Required packages: