Changes between Version 379 and Version 380 of BuildInstructions

Timestamp:

Nov 30, 2020, 10:12:59 AM (3 years ago)

Author:

wraitii

Comment:

Some changes for upcoming SM/C++17

BuildInstructions

@@ -16 +16 @@
    * [#Windows Windows] (7 or newer)
    * [#Linux Linux]
-   * [#OSX macOS / OS X] (10.7/Lion or newer)
+   * [#OSX macOS / OS X] (10.13/High Sierra or newer)
    * [#BSD FreeBSD/OpenBSD] (only experimental support at this time)
  * Up-to-date system software (Windows service packs, graphics driver updates, etc)
@@ -31 +31 @@
 Libraries are external dependencies (such as SpiderMonkey). For Windows and Linux, the script to create or update the Workspaces also handles installation and updating of libraries. For macOS, the `libraries/osx/build-osx-libs.sh` script should be used instead.
 
-Workspaces contain the integrations for code editors (such as Visual Studio, Xcode, etc.) as well as the Makefile for the main source code. The workspaces are auto-generated by the `update-workspaces` script from the `buids/workspaces/` directory.  Once ready, the integrations are ready for use, such as `build/workspaces/gcc/Makefile` (for Linux and macOS) and `build\workspaces\vc2015` (for Windows).
+Workspaces contain the integrations for code editors (such as Visual Studio, Xcode, etc.) as well as the Makefile for the main source code. The workspaces are auto-generated by the `update-workspaces` script from the `buids/workspaces/` directory.  Once ready, the integrations are ready for use, such as `build/workspaces/gcc/Makefile` (for Linux and macOS) and `build\workspaces\vs2017` (for Windows).
 
 Finally, the source code is build by the workspace. For example, by running `make` in `build/workspaces/gcc`.
@@ -45 +45 @@
 If you want to develop, the only supported IDE is:
 
- * Visual C++ 2015
+ * Visual C++ 2017
 
 '''Important notes:'''
 
- * We have dropped support for older versions of Visual Studio when moving to C++11, see #2669.
- * XP and Vista are supported as targets, but not for installing Visual Studio 2015.
+ * We have dropped support for older versions of Visual Studio when moving to C++14, see #5862.
+ * XP and Vista are supported as targets, but not for installing Visual Studio 2017.
  * Only 32-bit builds are supported, though they can be compiled and run on 64-bit Windows.
 
@@ -58 +58 @@
 
 === Setting up the build environment ===
-The game must be compiled with Microsoft Visual C++. You can get the free 2015 Community edition here: [https://www.visualstudio.com/vs/older-downloads/ Visual Studio older downloads]. You can also install Visual Studio 2017/2019 and choose to install the 2015 compiler (version 14.0). When choosing Visual Studio 2019, firstly Visual Studio 2015 have to be installed to be able to select the 2015 compiler. 
+The game must be compiled with Microsoft Visual C++. You can get the free 2017 Community edition here: [https://www.visualstudio.com/vs/older-downloads/ Visual Studio older downloads]. You can also install Visual Studio 2019 and choose to install the 2017 compiler (version 14.0).
 
 The Visual Studio project/solution files are automatically generated from the source files:
 
  * Run `cd build\workspaces` and then [source:/ps/trunk/build/workspaces/update-workspaces.bat update-workspaces.bat].
- * Open `build\workspaces\vc2015\pyrogenesis.sln`.
+ * Open `build\workspaces\vs2017\pyrogenesis.sln`.
 
 === Build configuration ===
@@ -95 +95 @@
 First you need to install various standard tools and development libraries:
 
+ * a C++17 conforming compiler
+ * the rust compiler and toolchain
  * Boost (at least 1.57 since r21726)
  * CMake (only needed if you use bundled NVTT)
- * GCC (at least 4.8.1, required by C++11 features)
  * Python 2.7 (required for cxxtest and non-system SpiderMonkey 45)
  * libcurl (at least 7.32)
@@ -142 +143 @@
      * `./update-workspaces.sh --with-system-nvtt`
      * If the game crashes at startup (#5757), you might need to use the bundled NVTT instead of the system-provided one: see below.
- * If you want to use a packaged **mozjs45**, which will be made available for example in [https://launchpad.net/~wfg/+archive/ubuntu/0ad.dev/+packages 0ad.dev PPA]:
-   * you should add `libmozjs-45-dev` and run `update-workspace.sh` with `--with-system-mozjs45`.
+ * If you want to use a packaged **SpiderMonkey**, which will be made available for example in [https://launchpad.net/~wfg/+archive/ubuntu/0ad.dev/+packages 0ad.dev PPA]:
+   * you should add `libmozjs-68-dev` and run `update-workspace.sh` with `--with-system-mozjs`.
  * When not using system nvidia-texture-tools, `libnvtt-dev` can be omitted, but `cmake` is needed to build the bundled NVTT.
  * You can also use `libcurl4-openssl-dev` instead of `libcurl4-gnutls-dev` (it's not possible to install both at once), but [http://lintian.debian.org/tags/possible-gpl-code-linked-with-openssl.html note that openssl is not GPL compatible and the resulting binaries could not be redistributed].
@@ -422 +423 @@
 
 === Dependencies ===
-1. '''Apple Command Line Tools for Xcode'''. There are a number of command-line tools you need that are not installed on macOS by default. Instead, these are available as a separate free download from Apple.  '''This does not include or require Xcode.''' It is branded as "for Xcode" but it works by itself.
-   * If you're using macOS 10.7 Lion or later, install this package from [https://developer.apple.com/downloads/index.action Apple Developer Downloads]. You need a (free) Apple ID to access the download. 
-   * See [https://developer.apple.com/library/archive/technotes/tn2339/_index.html Apple Command Line FAQ] for additional instructions.
-2. Python 2.7.3 or later If you're on Mountain Lion (10.8) or earlier, you will need to first update your Python installation with the latest 2.7.x installer from [https://www.python.org/downloads/release/python-279/ here].
+1. Install Xcode, version 10.1+ is recommended. Only 10.13+ are supported to compile the game.
+2. Install the command line tools for Xcode:
+   * Open a Terminal window and enter `xcode-select --install`.
+2. Install the rust toolchain.
+   * Open a Terminal window and enter `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`.
+   * See https://www.rust-lang.org/tools/install for more information.
 3. CMake:
-   * If you have [https://brew.sh/ Homebrew] installed, use [https://brewformulas.org/Cmake `brew install cmake`].
+   * (recommended) If you have [https://brew.sh/ Homebrew] installed, use [https://brewformulas.org/Cmake `brew install cmake`].
    * Alternatively, download a prebuilt macOS package at https://cmake.org/download/. If prompted, choose to install the "CMake command line tools" to the **default location**.
      * '''Note:''' Recent versions have no installer, so after copying the app bundle to '''Applications''', you need to run CMake with elevated permissions to install the command line tools. From the terminal: `sudo "/Applications/CMake.app/Contents/bin/cmake-gui" --install`.
@@ -468 +471 @@
 binaries/system/pyrogenesis
 }}}
- * '''Note:''' Newer versions of Xcode no longer include the command line tools by default, you need to install them as described above.
- * '''Note:''' It is recommended to use the command line build, since the Xcode build is not as well-tested, but Xcode's IDE can be very useful for code editing.
 
 == Create macOS distributable app bundle ==
+'''This is outdated and will soon change.'''
+
  * You will need Xcode installed (for its SDKs)
  * Open [source:/ps/trunk/build/workspaces/build-osx-bundle.sh build/workspaces/build-osx-bundle.sh] and read the comments. You will need to change a few settings depending on your version of macOS, Xcode, etc.
@@ -543 +546 @@
 
 === OpenBSD ===
- * As we require GCC 4.8.1+ you need to set `CC` and `CXX` before building
+ * You need to set `CC` and `CXX` before building
 {{{
 #!sh