CONTRIBUTING: Fix typos

[xonotic/darkplaces.git] / README.md

diff --git a/README.md b/README.md
index 168a911e76477903d27d4d76cefaad4dd7cffd65..df037d5c395d915012a76c835b768496c7d7751f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -51,6 +51,7 @@ These instructions are adequate for Quake, but for Xonotic please refer to [its
 ### Required packages
 
 The minimum SDL version is 2.0.18 for Linux and 2.24.0 for Windows.  
+The supported compilers are GCC and Clang.  
 The following package names are for Debian, see below for Windows and Mac.
 
 ##### Client
@@ -61,7 +62,7 @@ Runtime (optional): `libcurl` `libpng` `libfreetype6` `libvorbisfile`
 Build (mandatory): `build-essential` `libjpeg-dev` `zlib1g-dev`  
 Runtime (optional): `libcurl` `libpng`  
 
-### Windows (MSYS2):
+### Windows (MSYS2 MinGW):
 
 1. Install MSYS2, found [here](https://www.msys2.org/).
 2. Once you've installed MSYS2 and have fully updated it, open a MinGW64 terminal (***not an MSYS2 terminal***) and input the following command:
@@ -92,10 +93,21 @@ To build the main executable, input `make sdl-release` which creates the file ca
 If you get errors (that don't seem to be about missing dependencies) try `make clean` before compiling, especially if you updated your system since the last time you compiled.
 
 
-### Windows (Visual Studio)
+### Windows (Visual Studio 2019)
+
+Not recommended due to poor support for C standards, and lack of maintenance.
+
+DarkPlaces requires C11, so Windows SDK 10.0.20348.0 or later is needed.  
+To install it, run the Visual Studio Installer, click "Modify", click "Individual components", type "Windows SDK" in the search box, select the latest Windows SDK and de-select older versions.  
+You will also need "NuGet package manager" selected (to download SDL2 headers the first time you build).
+Click "Modify" to apply the changes.  
+
+Open `darkplaces-vs2019.sln`, select build type (`Debug` or `Release`) and platform (`Win32` or `x64`), and choose "Build Solution" from the "Build" menu to create files `darkplaces-sdl2-vs2019.exe` and `SDL2.dll`.
+
+The Release build crashes. The Debug x64 build doesn't crash (but is rather slow) so this will be Fun for someone to debug.
+
+To get a build suitable for playing you'll need to use MinGW GCC, or download the autobuild from Xonotic (see above).
 
-May work but not recommended due to lack of support for C standards, and lack of maintenance.  
-Instructions TODO.
 
 ## Contributing