Document how to build the editor

Technically, users only need to install the “C++ MFC for latest v143
build tools (x86 & x64)” component if they’re going to build the editor.
This commit tells users to install that component regardless of whether
or not they’re going to build the editor. This commit could have added
another step that said “install this component if you’re going to build
the editor”, but I thought that adding an additional step would make
things slightly harder for users with little benefit. After all, users
only need to install the MFC component once, and there’s a chance that
they’ll already have it installed.

Fixes #472.
This commit is contained in:
Jason Yundt 2024-06-29 05:11:50 -04:00
parent b1caee7c29
commit aa213980b8

View File

@ -93,7 +93,7 @@ The milestone needs testing on all platforms. Please report issues when found.
## Building
#### Building - Windows
1. Make sure that you have Git and Visual Studio 2022 with the “Desktop development with C++” workload. If you dont already have those installed or you arent sure, then open an elevated Command Prompt and run:
1. Make sure that you have Git and Visual Studio 2022 with the “Desktop development with C++” workload and the “C++ MFC for latest v143 build tools (x86 & x64)” component. If you dont already have those installed or you arent sure, then open an elevated Command Prompt and run:
<!--
The following code block specifies the full path to the Visual Studio Installer because the Visual Studio Installer doesnt add itself to the users Path. The installer is guaranteed to be in a specific location on 64-bit systems [1]. The installer will be in a different location on 32-bit systems [2], but Visual Studio 2022 doesnt support 32-bit systems [3] so we can ignore that detail.
@ -110,7 +110,8 @@ The milestone needs testing on all platforms. Please report issues when found.
--passive^
--channelId VisualStudio.17.Release^
--productId Microsoft.VisualStudio.Product.Community^
--add Microsoft.VisualStudio.Workload.NativeDesktop;includeRecommended
--add Microsoft.VisualStudio.Workload.NativeDesktop;includeRecommended^
--add Microsoft.VisualStudio.Component.VC.ATLMFC
```
2. Open a “x86 Native Tools Command Prompt” and run:
@ -118,7 +119,7 @@ The milestone needs testing on all platforms. Please report issues when found.
```batch
git clone https://github.com/DescentDevelopers/Descent3
cd Descent3
cmake --preset win32 -D ENABLE_LOGGER=[ON|OFF]
cmake --preset win32 -D ENABLE_LOGGER=[ON|OFF] -D BUILD_EDITOR=[ON|OFF]
cmake --build --preset win32 --config [Debug|Release]
```