Merge pull request #2622 from robluo/feature-basic-debug-documentation

[documentation] added how to debug build vpr documentation
verilog-to-routing · Jun 20, 2024 · 8192a19 · 8192a19
2 parents 95b8fee + 7cbfeff
commit 8192a19
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.developers.md b/README.developers.md
@@ -1092,6 +1092,12 @@ All tests passed (1 assertion in 1 test case)
 # Debugging Aids
 VTR has support for several additional tools/features to aid debugging.
 
+## Basic
+To build vpr with make in debug mode, simply add `BUILD_TYPE=debug` at the end of your make command. 
+```shell
+$ make vpr BUILD_TYPE=debug
+```
+
 ## Sanitizers
 VTR can be compiled using *sanitizers* which will detect invalid memory accesses, memory leaks and undefined behaviour (supported by both GCC and LLVM):
 ```shell