diff options
author | kcgen <1557255+kcgen@users.noreply.github.com> | 2021-04-20 17:21:53 +0300 |
---|---|---|
committer | Patryk Obara <dreamer.tan@gmail.com> | 2021-05-04 03:54:59 +0300 |
commit | b3acc39b046f999a0562eaf6fcea3bfc1a07a10e (patch) | |
tree | f2c618180cf02cd9f45f47943bad3a9efaf2c2e8 /docs | |
parent | caca8b3465953fee3144094214f0ac1f0ab53c12 (diff) |
Document how to build a debugger-enabled binary in Visual Studio
Diffstat (limited to 'docs')
-rw-r--r-- | docs/build-windows.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/build-windows.md b/docs/build-windows.md index d1d5ac899..8ce8c5568 100644 --- a/docs/build-windows.md +++ b/docs/build-windows.md @@ -11,6 +11,25 @@ Windows builds can be created using: 2. Install vcpkg: <https://github.com/Microsoft/vcpkg#quick-start-windows>. 3. Follow instructions in [README.md](/README.md). +### Create a Debugger build using Visual Studio + +Note that the debugger imposes a significant runtime performance penalty. +If you're not planning to use the debugger then the steps above will help +you build a binary optimized for gaming. + +1. Follow the steps above to setup a working build environment. +2. Install and integrate `pdcurses` using vcpkg: + + ``` shell + cd \vcpkg + .\vcpkg install --triplet pdcurses + .\vcpkg integrate install + ``` + +3. Edit `src\platform\visualc\config.h` and enable `C_DEBUG` and optionally + `C_HEAVY_DEBUG` by setting them to `1` instead of `0`. +4. Select a **Release** build type in Visual Studio, and run the build. + ## Build using MSYS2 1. Install MSYS2: <https://www.msys2.org/> |