Skip to content

Commit bd4833e

Browse files
committed
Update README.md
Clarify platform-specific and buildsystem-specific requirements for working with VS Code
1 parent d87a94b commit bd4833e

File tree

1 file changed

+24
-15
lines changed

1 file changed

+24
-15
lines changed

README.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -144,21 +144,30 @@ If you want to change the buildtype afterwards, you can use `meson configure --b
144144
***
145145
## Debugging with VS Code
146146

147-
This repository includes launch configurations to automatically build and debug the game using [VS Code](https://code.visualstudio.com/) on any of the supported platforms.
148-
149-
#### Requirements
150-
- [C/C++ Extension Pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools-extension-pack) extension (all platforms)
151-
- **Windows**
152-
- [msbuild command line tools](https://learn.microsoft.com/en-us/visualstudio/msbuild/msbuild?view=vs-2022) (installed either via Visual Studio or manually)
153-
154-
- **Linux & macOS**
155-
- [All the dependencies listed above](#dependencies)
156-
- The [Meson](https://marketplace.visualstudio.com/items?itemName=mesonbuild.mesonbuild) editor extension
157-
- The [`lldb`](https://lldb.llvm.org/) debugger *(macOS only*)
158-
159-
These launch configurations are accessible via the [Run and Debug](https://code.visualstudio.com/docs/editor/debugging#_run-and-debug-view) view, and provide profiles to build and run the game in Release mode or any of the [3 Debug modes](https://github.com/cortex-command-community/Cortex-Command-Community-Project-Source/wiki/Meson-build-options).
160-
161-
Note that Windows / Unix & macOS users should use the launch configurations in the `msbuild` and `meson` groups respectively.
147+
This repository includes launch configurations to automatically build and debug the game using [VS Code](https://code.visualstudio.com/) on any of the supported platforms using one of the two supported build systems.
148+
149+
### Requirements
150+
- [C/C++ Extension Pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools-extension-pack) extension (all platforms)
151+
152+
#### msbuild *(Windows only)*
153+
- [msbuild command line tools](https://learn.microsoft.com/en-us/visualstudio/msbuild/msbuild?view=vs-2022) (available [here](https://visualstudio.microsoft.com/downloads/?q=build+tools#build-tools-for-visual-studio-2022)), available on system `PATH`
154+
- The `fmod.dll` library must be copied to the **Data Repository** (as above)
155+
156+
#### meson *(All platforms)*
157+
- meson, [as above](#dependencies), available on the system `PATH`
158+
- The [meson editor extension](https://marketplace.visualstudio.com/items?itemName=mesonbuild.mesonbuild)
159+
- Run the provided `Setup Meson` task, found via the command palette -> `Tasks: Run Task`
160+
- Windows:
161+
- [Visual Studio (2022) C++ Build Tools](https://visualstudio.microsoft.com/downloads/?q=build+tools#build-tools-for-visual-studio-2022) [`MSVC v143`], available on the system `PATH`
162+
- The `fmod.dll` library must be copied to the **Data Repository** (as above)
163+
- Linux:
164+
- [All the dependencies listed above](#dependencies)
165+
- macOS:
166+
- [All the dependencies listed above](#dependencies)
167+
- The [`lldb`](https://lldb.llvm.org/) debugger
168+
169+
170+
These launch configurations are accessible via the [Run and Debug](https://code.visualstudio.com/docs/editor/debugging#_run-and-debug-view) view, and provide profiles to build and run the game in Release mode or any of the [3 Debug modes](https://github.com/cortex-command-community/Cortex-Command-Community-Project-Source/wiki/Meson-build-options).
162171

163172
All configurations will run pre-launch tasks to build the game using the supported backend before launching.
164173

0 commit comments

Comments
 (0)