From b3513cd7fa207acd249973c753b1bb8c218c678e Mon Sep 17 00:00:00 2001 From: scribam Date: Mon, 10 Jun 2019 21:52:07 +0200 Subject: [PATCH] Set minimum supported version of GCC to 8.x And update the documentation accordingly --- BUILDING.md | 116 ++++++++++++++++++++ README.md | 84 +------------- rpcs3/Emu/CMakeLists.txt | 2 +- rpcs3/cmake_modules/ConfigureCompiler.cmake | 6 +- 4 files changed, 124 insertions(+), 84 deletions(-) create mode 100644 BUILDING.md diff --git a/BUILDING.md b/BUILDING.md new file mode 100644 index 0000000000..d32050e919 --- /dev/null +++ b/BUILDING.md @@ -0,0 +1,116 @@ +# Building + +Only Windows and Linux are officially supported for building. However, various other platforms are capable of building RPCS3. +Other instructions may be found [here](https://wiki.rpcs3.net/index.php?title=Building). + +## Setup your environment + +### Windows 7 or later + +* [CMake 3.8.2+](https://www.cmake.org/download/) (add to PATH) +* [Python 3.3+](https://www.python.org/downloads/) (add to PATH) +* [Qt 5.10+](https://www.qt.io/download-qt-installer) (Avoid 5.11.1, due to a bug) +* [Visual Studio 2017](https://visualstudio.microsoft.com/vs/older-downloads/) +* [Vulkan SDK 1.1.97.0+](https://vulkan.lunarg.com/sdk/home) (See "Install the SDK" [here](https://vulkan.lunarg.com/doc/sdk/latest/windows/getting_started.html)) + +**Either add the** `QTDIR` **environment variable, e.g.** `\5.10.0\msvc2017_64\` **, or use the [Visual Studio Qt Plugin](https://marketplace.visualstudio.com/items?itemName=TheQtCompany.QtVisualStudioTools-19123)** + +### Linux + +These are the essentials tools to build RPCS3 on Linux. Some of them can be installed through your favorite package manager. + +* Clang 5.0+ or GCC 8.1+ +* [CMake 3.8.2+](https://www.cmake.org/download/) +* [Qt 5.10+](https://www.qt.io/download-qt-installer) (Avoid 5.11.1, due to a bug) +* [Vulkan SDK 1.1.97.0+](https://vulkan.lunarg.com/sdk/home) (See "Install the SDK" [here](https://vulkan.lunarg.com/doc/sdk/latest/linux/getting_started.html)) + +**If you have an NVIDIA GPU, you may need to install the libglvnd package.** + +#### Arch Linux + + sudo pacman -S glew openal cmake vulkan-validation-layers qt5-base qt5-declarative + +#### Debian & Ubuntu + + sudo apt-get install cmake build-essential libasound2-dev libpulse-dev libopenal-dev libglew-dev zlib1g-dev libedit-dev libvulkan-dev libudev-dev git qt5-default libevdev-dev qtdeclarative5-dev qtbase5-private-dev + +##### GCC 8.x installation + +If the `gcc-8` package is not available on your system, use the following command +``` +sudo add-apt-repository ppa:ubuntu-toolchain-r/test +``` +Then +``` +sudo apt-get update +sudo apt-get install gcc-8 g++-8 +``` + +You can either use `update-alternatives` to setup `gcc-8`/`g++-8` as your default compilers or prefix any `cmake` command by `CXX=g++-8 CC=gcc-8 ` to use it. + +##### Vulkan SDK + +For Ubuntu systems, it is strongly recommended to use the PPA from [LunarG](https://packages.lunarg.com/) which will provide a compatible Vulkan SDK to compile RPCS3. If your Vulkan SDK is older, it can lead to compilation errors. + +Ubuntu 18.04 (Bionic Beaver) +``` +wget -qO - http://packages.lunarg.com/lunarg-signing-key-pub.asc | sudo apt-key add - +sudo wget -qO /etc/apt/sources.list.d/lunarg-vulkan-1.1.106-bionic.list http://packages.lunarg.com/vulkan/1.1.106/lunarg-vulkan-1.1.106-bionic.list +sudo apt update +sudo apt install vulkan-sdk +``` + +Ubuntu 16.04 (Xenial Xerus) +``` +wget -qO - http://packages.lunarg.com/lunarg-signing-key-pub.asc | sudo apt-key add - +sudo wget -qO /etc/apt/sources.list.d/lunarg-vulkan-1.1.106-xenial.list http://packages.lunarg.com/vulkan/1.1.106/lunarg-vulkan-1.1.106-xenial.list +sudo apt update +sudo apt install vulkan-sdk +``` + +#### Fedora + + sudo dnf install alsa-lib-devel cmake glew glew-devel libatomic libevdev-devel libudev-devel openal-devel qt5-devel vulkan-devel + +#### OpenSUSE + + sudo zypper install git cmake libasound2 libpulse-devel openal-soft-devel glew-devel zlib-devel libedit-devel vulkan-devel libudev-devel libqt5-qtbase-devel libevdev-devel + +## Setup the project + +Clone and initialize the repository + +``` +git clone https://github.com/RPCS3/rpcs3.git +cd rpcs3 +git submodule update --init +``` + +### Windows + +#### Configuring the Qt plugin (if used) + +1) Go to the Qt5 menu and edit Qt5 options. +2) Add the path to your Qt installation with compiler e.g. `\5.10.0\msvc2017_64`. +3) While selecting the rpcs3qt project, go to Qt5->Project Setting and select the version you added. + +#### Building the projects + +Open `rpcs3.sln`. The recommended build configuration is `Release - LLVM` for all purposes. + +You may want to download precompiled [LLVM libs](https://github.com/RPCS3/llvm/releases/download/continuous-master/llvmlibs.7z) and extract to root rpcs3 folder (which contains `rpcs3.sln`), as well as download and extract [additional libs](https://drive.google.com/uc?export=download&id=1A2eOMmCO714i0U7J0qI4aEMKnuWl8l_R) to `lib\%CONFIGURATION%-x64\` to speed up compilation time (unoptimised/debug libs are currently not available precompiled). + +If you're not using precompiled libs, build the projects in *__BUILD_BEFORE* folder: right-click on every project > *Build*. + +`Build > Build Solution` + +### Linux + +While still in the project root: + +1) `cd .. && mkdir rpcs3_build && cd rpcs3_build` +2) `cmake ../rpcs3/ && make` or `CXX=g++-8 CC=gcc-8 cmake ../rpcs3/ && make` to force these compilers +3) Run RPCS3 with `./bin/rpcs3` + +When using GDB, configure it to ignore SIGSEGV signal (`handle SIGSEGV nostop noprint`). +If desired, use the various build options in [CMakeLists](https://github.com/RPCS3/rpcs3/blob/master/CMakeLists.txt). diff --git a/README.md b/README.md index 9dc06909ce..7999cd11da 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,6 @@ For discussion about this emulator, PS3 emulation, and game compatibility report [**Support Lead Developers Nekotekina and kd-11 on Patreon**](https://www.patreon.com/Nekotekina) - ## Contributing If you want to help the project but do not code, the best way to help out is to test games and make bug reports. See: @@ -25,90 +24,15 @@ If you want to contribute as a developer, please take a look at the following pa You should also contact any of the developers in the forums or in the Discord server to learn more about the current state of the emulator. - -## Dependencies - -### Windows -* [Visual Studio 2017](https://www.visualstudio.com/en/downloads/) -* [Visual C++ Redistributable Packages for Visual Studio 2017](https://go.microsoft.com/fwlink/?LinkId=746572) -* [CMake 3.8.2+](https://www.cmake.org/download/) (add to PATH) -* [Python 3.3+](https://www.python.org/downloads/) (add to PATH) -* [Vulkan SDK](https://vulkan.lunarg.com/sdk/home) (See "Install the SDK" [here](https://vulkan.lunarg.com/doc/sdk/latest/windows/getting_started.html)) -* [Qt 5.10+](https://www.qt.io/download-qt-installer) (Avoid 5.11.1, due to a bug) - - -**Either add the** `QTDIR` **environment variable, e.g.** `\5.11.2\msvc2017_64\` **, or use the [Visual Studio Qt Plugin](https://marketplace.visualstudio.com/items?itemName=TheQtCompany.QtVisualStudioTools-19123)** - -### Linux -* [Qt 5.10+](https://www.qt.io/download-open-source/) (Avoid 5.11.1, due to a bug) -* GCC 7.3+ or Clang 5.0+ -* CMake 3.8.2+ -* Debian & Ubuntu: `sudo apt-get install cmake build-essential libasound2-dev libpulse-dev libopenal-dev libglew-dev zlib1g-dev libedit-dev libvulkan-dev libudev-dev git qt5-default libevdev-dev qtdeclarative5-dev qtbase5-private-dev` -* Arch: `sudo pacman -S glew openal cmake vulkan-validation-layers qt5-base qt5-declarative` -* Fedora: `sudo dnf install alsa-lib-devel cmake glew glew-devel libatomic libevdev-devel libudev-devel openal-devel qt5-devel vulkan-devel` -* OpenSUSE: `sudo zypper install git cmake libasound2 libpulse-devel openal-soft-devel glew-devel zlib-devel libedit-devel vulkan-devel libudev-devel libqt5-qtbase-devel libevdev-devel` - -**If you have an NVIDIA GPU, you may need to install the libglvnd package.** - -#### Vulkan-SDK - -For Ubuntu systems, it is strongly recommended to use the PPA from [LunarG](https://packages.lunarg.com/) which will provide a compatible Vulkan-SDK to compile RPCS3. If your Vulkan-SDK is older, it can lead to compilation errors. - -##### Ubuntu 18.04 (Bionic Beaver) -``` -wget -qO - http://packages.lunarg.com/lunarg-signing-key-pub.asc | sudo apt-key add - -sudo wget -qO /etc/apt/sources.list.d/lunarg-vulkan-1.1.106-bionic.list http://packages.lunarg.com/vulkan/1.1.106/lunarg-vulkan-1.1.106-bionic.list -sudo apt update -sudo apt install vulkan-sdk -``` - -##### Ubuntu 16.04 (Xenial Xerus) -``` -wget -qO - http://packages.lunarg.com/lunarg-signing-key-pub.asc | sudo apt-key add - -sudo wget -qO /etc/apt/sources.list.d/lunarg-vulkan-1.1.106-xenial.list http://packages.lunarg.com/vulkan/1.1.106/lunarg-vulkan-1.1.106-xenial.list -sudo apt update -sudo apt install vulkan-sdk -``` - ## Building -Only Windows and Linux are officially supported for building. However, various other platforms are capable of building RPCS3. Other instructions may be found [here](https://wiki.rpcs3.net/index.php?title=Building). +See [BUILDING.md](BUILDING.md) for more information about how to setup an environment to build RPCS3. -Clone and initialize the repository: +## Running -1) `git clone https://github.com/RPCS3/rpcs3.git` -2) `cd rpcs3/` -3) `git submodule update --init` +Check our friendly [quickstart](https://rpcs3.net/quickstart) guide to make sure your computer meets the minimum system requirements to run RPCS3. -### Windows -#### Configuring the Qt plugin (if used) - -1) Go to the Qt5 menu and edit Qt5 options. -2) Add the path to your Qt installation with compiler e.g. `\5.11.2\msvc2017_64`. -3) While selecting the rpcs3qt project, go to Qt5->Project Setting and select the version you added. - -#### Building the projects - -Open `rpcs3.sln`. The recommended build configuration is `Release - LLVM` for all purposes. - -You may want to download precompiled [LLVM libs](https://github.com/RPCS3/llvm/releases/download/continuous-master/llvmlibs.7z) and extract to root rpcs3 folder (which contains `rpcs3.sln`), as well as download and extract [additional libs](https://drive.google.com/uc?export=download&id=1A2eOMmCO714i0U7J0qI4aEMKnuWl8l_R) to `lib\%CONFIGURATION%-x64\` to speed up compilation time (unoptimised/debug libs are currently not available precompiled). - -If you're not using precompiled libs, build the projects in *__BUILD_BEFORE* folder: right-click on every project > *Build*. - - -`Build > Build Solution` - - -### Linux - -While still in the project root: - -1) `cd .. && mkdir rpcs3_build && cd rpcs3_build` -2) `cmake ../rpcs3/ && make` -3) Run RPCS3 with `./bin/rpcs3` - -When using GDB, configure it to ignore SIGSEGV signal (`handle SIGSEGV nostop noprint`). -If desired, use the various build options in [CMakeLists](https://github.com/RPCS3/rpcs3/blob/master/CMakeLists.txt). +Don't forget to have your graphics driver up to date and to install the [Visual C++ Redistributable Packages for Visual Studio 2017](https://go.microsoft.com/fwlink/?LinkId=746572) if you are a Windows user. ## License diff --git a/rpcs3/Emu/CMakeLists.txt b/rpcs3/Emu/CMakeLists.txt index 40d75cda6f..9b76530d63 100644 --- a/rpcs3/Emu/CMakeLists.txt +++ b/rpcs3/Emu/CMakeLists.txt @@ -63,7 +63,7 @@ target_link_libraries(rpcs3_emu PRIVATE 3rdparty::stblib 3rdparty::libpng) -if(CMAKE_COMPILER_IS_GNUCXX AND (CMAKE_CXX_COMPILER_VERSION VERSION_GREATER 7 OR CMAKE_CXX_COMPILER_VERSION VERSION_EQUAL 7)) +if(CMAKE_COMPILER_IS_GNUCXX) target_link_libraries(rpcs3_emu PUBLIC -latomic) endif() diff --git a/rpcs3/cmake_modules/ConfigureCompiler.cmake b/rpcs3/cmake_modules/ConfigureCompiler.cmake index 196e7cef22..4dec843427 100644 --- a/rpcs3/cmake_modules/ConfigureCompiler.cmake +++ b/rpcs3/cmake_modules/ConfigureCompiler.cmake @@ -1,9 +1,9 @@ # Check and configure compiler options for RPCS3 if(CMAKE_COMPILER_IS_GNUCXX) - # GCC 7.3 or latter is required - if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS 7.3) - message(FATAL_ERROR "RPCS3 requires at least gcc-7.3.") + # GCC 8.1 or latter is required + if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS 8) + message(FATAL_ERROR "RPCS3 requires at least gcc-8.") endif() # Set compiler options here