diff --git a/README.md b/README.md index e415756f7..0110f2222 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ Similarly, you can include attachments (like assets as support material for a tu ## Building with Sphinx -To build the HTML website (or any other format supported by Sphinx, like PDF, EPUB or LaTeX), you need to install [Sphinx](https://www.sphinx-doc.org/) >= 1.3 as well as (for the HTML) the [readthedocs.org theme](https://github.com/snide/sphinx_rtd_theme). Only the Python 3 flavor was tested, though the Python 2 versions might work too. +To build the HTML website (or any other format supported by Sphinx, like PDF, EPUB or LaTeX), you need to install [Sphinx](https://www.sphinx-doc.org/) >= 1.3 as well as (for the HTML) the [readthedocs.org theme](https://github.com/snide/sphinx_rtd_theme). You also need to install the Sphinx extensions defined in `requirements.txt`. Those tools are best installed using [pip](https://pip.pypa.io), Python's module installer. The Python 3 version might be provided (on Linux distros) as `pip3` or `python3-pip`. You can then run: diff --git a/development/compiling/compiling_for_android.rst b/development/compiling/compiling_for_android.rst index cfbba86d2..1cb360655 100644 --- a/development/compiling/compiling_for_android.rst +++ b/development/compiling/compiling_for_android.rst @@ -21,18 +21,19 @@ Requirements For compiling under Windows, Linux or macOS, the following is required: -- `Python 3.5+ `_ -- `SCons `_ build system -- `Android SDK `_ (command-line tools are sufficient) +- `Python 3.5+ `_. +- `SCons 3.0+ `_ build system. +- `Android SDK `_ + (command-line tools are sufficient). - - Required SDK components will be automatically installed by Gradle (except the NDK) + - Required SDK components will be automatically installed by Gradle (except the NDK). -- `Android NDK `_ r17 or later -- Gradle (will be downloaded and installed automatically if missing) -- JDK 8 (either OpenJDK or Oracle JDK) +- `Android NDK `_ r17 or later. +- Gradle (will be downloaded and installed automatically if missing). +- JDK 8 (either OpenJDK or Oracle JDK). - - JDK 9 or later are not currently supported - - You can download a build from `ojdkbuild `_ + - JDK 9 or later are not currently supported. + - You can download a build from `ojdkbuild `_. .. seealso:: For a general overview of SCons usage for Godot, see :ref:`doc_introduction_to_the_buildsystem`. diff --git a/development/compiling/compiling_for_ios.rst b/development/compiling/compiling_for_ios.rst index 9a277d54a..b9c989846 100644 --- a/development/compiling/compiling_for_ios.rst +++ b/development/compiling/compiling_for_ios.rst @@ -8,8 +8,8 @@ Compiling for iOS Requirements ------------ -- SCons (you can get it from macports, you should be able to run - ``scons`` in a terminal when installed) +- SCons 3.0+ (you can install it via Homebrew or Macports, you should be able + to run ``scons`` in a terminal when installed). - Xcode 10.0 (or later) with the iOS (10.0) SDK and the command line tools. .. seealso:: For a general overview of SCons usage for Godot, see diff --git a/development/compiling/compiling_for_osx.rst b/development/compiling/compiling_for_osx.rst index d5468c257..080e735f6 100644 --- a/development/compiling/compiling_for_osx.rst +++ b/development/compiling/compiling_for_osx.rst @@ -10,8 +10,8 @@ Requirements For compiling under macOS, the following is required: -- `Python 3.5+ `_ -- `SCons `_ build system. +- `Python 3.5+ `_. +- `SCons 3.0+ `_ build system. - `Xcode `_ (or the more lightweight Command Line Tools for Xcode). - *Optional* - `yasm `_ (for WebM SIMD optimizations). diff --git a/development/compiling/compiling_for_uwp.rst b/development/compiling/compiling_for_uwp.rst index f8121efc0..e299604c5 100644 --- a/development/compiling/compiling_for_uwp.rst +++ b/development/compiling/compiling_for_uwp.rst @@ -8,10 +8,9 @@ Compiling for Universal Windows Platform Requirements ------------ -- SCons (see :ref:`doc_compiling_for_windows` for more details). -- Visual Studio 2015 Update 2. It may work with earlier versions. See - :ref:`doc_compiling_for_windows` about the caveats of installing it - and the various prompts. +- SCons 3.0+ (see :ref:`doc_compiling_for_windows` for more details). +- Visual Studio 2017 or later. See :ref:`doc_compiling_for_windows` about the + caveats of installing it and the various prompts. - Windows 10 SDK (can be selected in Visual Studio installation). - `ANGLE source `__. Use the ``ms_master`` (default) branch. Keep it in a path without spaces to @@ -21,7 +20,8 @@ Requirements ``ms_master`` branch has been cleared out. As a temporary workaround however, it is still possible to - download an older state of the source code via commit `c61d048 `__. + download an older state of the source code via commit + `c61d048 `__. This page will eventually be updated in the future to reflect the new build instructions. diff --git a/development/compiling/compiling_for_web.rst b/development/compiling/compiling_for_web.rst index 6dca58e3d..b0e8560af 100644 --- a/development/compiling/compiling_for_web.rst +++ b/development/compiling/compiling_for_web.rst @@ -10,11 +10,9 @@ Requirements To compile export templates for the Web, the following is required: -- `Emscripten 1.38.27+ `__: If the version available - per package manager is not recent enough, the best alternative is to install - using the `Emscripten SDK `__ -- `Python 3.5+ `__ -- `SCons `__ build system +- `Emscripten 1.39.0+ `__. +- `Python 3.5+ `__. +- `SCons 3.0+ `__ build system. .. seealso:: For a general overview of SCons usage for Godot, see :ref:`doc_introduction_to_the_buildsystem`. diff --git a/development/compiling/compiling_for_windows.rst b/development/compiling/compiling_for_windows.rst index 2b109ee50..790a82272 100644 --- a/development/compiling/compiling_for_windows.rst +++ b/development/compiling/compiling_for_windows.rst @@ -11,14 +11,14 @@ Requirements For compiling under Windows, the following is required: - `Visual Studio Community `_, - version 2015 (14.0) or later. VS 2019 is recommended. + version 2017 or later. VS 2019 is recommended. **Make sure to read "Installing Visual Studio caveats" below or you will have to run/download the installer again.** -- MinGW-w64 with GCC can be used as an alternative to Visual Studio. - Be sure to install/configure it to use the ``posix`` thread model. -- `Python 3.5+ `_ -- `SCons `_ build system. If using Visual Studio 2019, - you *must* have SCons 3.1.1 or later. +- `MinGW-w64 `_ with GCC can be used as an alternative to + Visual Studio. Be sure to install/configure it to use the ``posix`` thread model. +- `Python 3.5+ `_. +- `SCons 3.0 `_ build system. If using Visual Studio 2019, + you need at least SCons 3.1.1. - *Optional* - `yasm `_ (for WebM SIMD optimizations) .. note:: If you have `Scoop `_ installed, you can easily diff --git a/development/compiling/compiling_for_x11.rst b/development/compiling/compiling_for_x11.rst index e25651c07..d8634c7c0 100644 --- a/development/compiling/compiling_for_x11.rst +++ b/development/compiling/compiling_for_x11.rst @@ -11,16 +11,19 @@ Requirements For compiling under Linux or other Unix variants, the following is required: -- GCC or Clang -- Python 3.5+ -- SCons build system (3.0 or later for Python 3) -- pkg-config (used to detect the dependencies below) -- X11, Xcursor, Xinerama, Xi and XRandR development libraries -- MesaGL development libraries -- ALSA development libraries -- PulseAudio development libraries -- *Optional* - libudev (build with ``udev=yes``) -- *Optional* - yasm (for WebM SIMD optimizations) +- GCC 7+ or Clang 6+. +- Python 3.5+. +- SCons 3.0+ build system. If your Linux distribution only provides a Python 2 + build of SCons, install the Python 3 flavor with ``pip3 install --user scons``. + You may also want to uninstall the distribution ``scons`` package to ensure + that the pip-installed one takes precedence. +- pkg-config (used to detect the dependencies below). +- X11, Xcursor, Xinerama, Xi and XRandR development libraries. +- MesaGL development libraries. +- ALSA development libraries. +- PulseAudio development libraries. +- *Optional* - libudev (build with ``udev=yes``). +- *Optional* - yasm (for WebM SIMD optimizations). .. seealso:: For a general overview of SCons usage for Godot, see :ref:`doc_introduction_to_the_buildsystem`. diff --git a/getting_started/workflow/export/exporting_for_web.rst b/getting_started/workflow/export/exporting_for_web.rst index 64cd17dbe..595862ff8 100644 --- a/getting_started/workflow/export/exporting_for_web.rst +++ b/getting_started/workflow/export/exporting_for_web.rst @@ -17,8 +17,7 @@ in the user's browser. ``file://`` protocol. To get around this, use a local server. .. tip:: Python offers an easy method to start a local server. - Use ``python -m SimpleHTTPServer`` with Python 2 or - ``python -m http.server`` with Python 3 to serve the + Use ``python -m http.server`` with Python 3 to serve the current working directory at ``http://localhost:8000``. WebGL 2