ShuriZma
/
dolphin
mirror of https://github.com/dolphin-emu/dolphin.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update Readme.md 

Reword submodule statement to be more general.
Add pointer about dealing with clang-format.
This commit is contained in:
shuffle2 2019-12-19 11:24:35 -08:00 committed by GitHub
parent 74dedc57fd
commit 12267fb21e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Readme.md
View File

@ -39,11 +39,11 @@ Dolphin can only be installed on devices that satisfy the above requirements. At
## Building for Windows ## Building for Windows
Use the solution file `Source/dolphin-emu.sln` to build Dolphin on 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 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. 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 ```sh
git submodule update --init 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 (NSIS) to be installed. Creating an installer is not necessary to run Dolphin
since the Binary directory contains a working Dolphin distribution. 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 ## Building for Linux and macOS
Dolphin requires [CMake](https://cmake.org/) for systems other than Windows. Many libraries are Dolphin requires [CMake](https://cmake.org/) for systems other than Windows. Many libraries are