Skip to content

Commit

Permalink
Simplify the MSVC install instructions
Browse files Browse the repository at this point in the history
This line can be simplified from:
`If installing Visual Studio 2017 or 2019, make sure to enable **C++** in
the list of workflows to install.`
To:
`Make sure to enable **C++** in the list of workflows to install.`

This line is not needed as we don't support 2015 anymore:
`If installing Visual Studio 2015, make sure to run a **Custom**
installation instead of **Typical** and select **C++** as a language there.`

This can be simplified from:
`If you've already made the mistake of installing Visual Studio without
C++ support, run the installer again; it should present you a **Modify** button.`
To:
`If you've already installed Visual Studio without C++ support, run the installer
again; it should present you a **Modify** button.`

From my checking on my system, this line is no longer true, so we can remove it:
`Running the installer from *Add/Remove Programs* will only give you
a **Repair** option, which won't let you install C++ tools.`

Now we can move the simplified text up so that the reader does not have to dig through the entire document to find that important bit of information, while not making the text at the top much longer due removing outdated information.
  • Loading branch information
chrisl8 committed Apr 11, 2024
1 parent 1677faa commit 4b47a47
Showing 1 changed file with 3 additions and 16 deletions.
19 changes: 3 additions & 16 deletions contributing/development/compiling/compiling_for_windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@ For compiling under Windows, the following is required:

- `Visual Studio Community <https://www.visualstudio.com/vs/community/>`_,
version 2019 or later. Visual Studio 2022 is recommended.
**Make sure to read "Installing Visual Studio caveats" below or you
will have to run/download the installer again.**
**Make sure to enable C++ in the list of workflows to install.**
If you've already installed Visual Studio without C++ support, run the installer
again; it should present you a **Modify** button.
- `MinGW-w64 <https://mingw-w64.org/>`_ with GCC can be used as an alternative to
Visual Studio. Be sure to install/configure it to use the ``posix`` thread model.
**Important:** When using MinGW to compile the ``master`` branch, you need GCC 9 or later.
Expand Down Expand Up @@ -76,20 +77,6 @@ SCons version is too old. Update it to the latest version with

.. _doc_compiling_for_windows_install_vs:

Installing Visual Studio caveats
--------------------------------

If installing Visual Studio 2017 or 2019, make sure to enable **C++** in
the list of workflows to install.

If installing Visual Studio 2015, make sure to run a **Custom**
installation instead of **Typical** and select **C++** as a language there.

If you've already made the mistake of installing Visual Studio without
C++ support, run the installer again; it should present you a **Modify** button.
Running the installer from *Add/Remove Programs* will only give you
a **Repair** option, which won't let you install C++ tools.

Downloading Godot's source
--------------------------

Expand Down

0 comments on commit 4b47a47

Please sign in to comment.