From 12267fb21e0d59d1459a0923ab0ae833a3730ba8 Mon Sep 17 00:00:00 2001 From: shuffle2 Date: Thu, 19 Dec 2019 11:24:35 -0800 Subject: [PATCH] Update Readme.md Reword submodule statement to be more general. Add pointer about dealing with clang-format. --- Readme.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/Readme.md b/Readme.md index dd5a19e9db..97bec9e4e4 100644 --- a/Readme.md +++ b/Readme.md @@ -39,11 +39,11 @@ Dolphin can only be installed on devices that satisfy the above requirements. At ## Building for Windows Use the solution file `Source/dolphin-emu.sln` to build Dolphin on Windows. -Visual Studio 2019 16.3 is a hard requirement. Other compilers might be +Visual Studio 2019 16.3 or later is a hard requirement. Other compilers might be able to build Dolphin on Windows but have not been tested and are not recommended to be used. Git and Windows 10 SDK must be installed when building. -Make sure to check out the Qt submodule before building: +Make sure to pull submodules before building: ```sh git submodule update --init ``` @@ -56,6 +56,11 @@ Installer directory. This will require the Nullsoft Scriptable Install System (NSIS) to be installed. Creating an installer is not necessary to run Dolphin since the Binary directory contains a working Dolphin distribution. +To ease contributing code to Dolphin which has been modified in Visual Studio, +install clang-format-7 by installing a 7.x version of the LLVM tools from http://releases.llvm.org. +In Visual Studio, under Options > Text Editor > C/C++ > Formatting > General, +enable "Use custom clang-format.exe file" and point it to the just-installed clang-format.exe + ## Building for Linux and macOS Dolphin requires [CMake](https://cmake.org/) for systems other than Windows. Many libraries are