Skip to content

Commit ce95d68

Browse files
authored
Update developer "getting started" docs (#1985)
* Add note about lack of support for vs2026 (for now) * Add note about no official msvc 2026 support * Add new Run configuration info for Qt Creator Add extra info since we have some default test related run configurations possibly being populated as the default selection now, rather than a blank slate.
1 parent a0a05e5 commit ce95d68

2 files changed

Lines changed: 13 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@ See [README.md](README.md) in this repo for setting up your build environment (c
3131
To be safe and avoid problems with VAC, it's recommended to add a [-insecure](https://developer.valvesoftware.com/wiki/Command_Line_Options) launch flag before attaching your debugger.
3232

3333
#### VS2022 + CMake (Windows)
34+
35+
> [!NOTE]
36+
> We do *not* officially support Visual Studio 2026 at this time! If you run into issues, please consider downgrading to VS 2022 for now.
37+
>
38+
3439
In the CMake Target View, right-click "client (shared library)" and click on "Add Debug Configuration". This should generate the `src/.vs/launch.vs.json` config file.
3540

3641
Modify the config to fix the directory paths; an example is provided below:
@@ -61,7 +66,13 @@ Modify the config to fix the directory paths; an example is provided below:
6166
```
6267

6368
#### Qt Creator (Linux)
64-
On the sidebar, click "Projects" then under your current kit, click "Run". Set the following:
69+
On the sidebar, click "Projects" then under your current kit, click "Run".
70+
71+
By default, you may have one of the test configurations chosen as the currently active run configuration (`test_neo_crosshair`, etc).
72+
To create a new configuration, press "Add" and choose "Custom executable" (tested on Qt Creator 13.0.0, but the exact menus and wording
73+
may depend on your Qt Creator version).
74+
75+
Once you have a fresh *Run configuration* created, set the following properties for it:
6576

6677
| Property | Example value |
6778
| :---------------------------------- | :------------ |

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ To see the Table of Contents, please use the "Outline" feature on GitHub by clic
1414

1515
* Windows: [Visual Studio 2022 (MSVC v143)](https://visualstudio.microsoft.com/downloads/)
1616
* Make sure to include C++ development environment, C++ MFC Library, Windows 10/11 SDK, and CMake during installation
17+
* Please note that we do not currently officially support Visual Studio 2026
1718
* Linux: [Steam Runtime 3 "Sniper"](https://gitlab.steamos.cloud/steamrt/sniper/sdk)
1819
* GCC/G++ 10 toolchain
1920
* Compiled in the sniper's Docker/Podman/Toolbx container, schroot, or systemd-nspawn

0 commit comments

Comments
 (0)