Updated Building for Windows (markdown)

shuffle2 2019-12-19 11:05:24 -08:00
parent 0198e74582
commit 65b512a42f
1 changed files with 12 additions and 27 deletions

@ -1,40 +1,25 @@
## Prerequisites
- Windows 7 SP1 or higher, 64-bit version
- [Visual Studio 2017](https://www.visualstudio.com/downloads/)
- You can use any version of VS (Community Edition is free)
- Minimum components to install for building and basic debugging:
![Visual Studio Options](https://raw.githubusercontent.com/wiki/dolphin-emu/dolphin/vs-options.png)
- Required to get source and build:
- [Visual Studio 2019](https://www.visualstudio.com/downloads/)
- You can use any edition of VS (Community Edition is free)
- Easiest to just choose "Desktop development with C++" workload
- However, minimum required to get source and build are:
- Git for Windows (Note: [The standalone git installer](https://git-scm.com/download/win) is more recent and is compatible with VS)
- C++ core features
- Latest VC++ toolset (x64)
- Latest Windows SDK for Desktop C++ x64
- Recommended (development / debugging)
- Latest Windows SDK
- Recommended for development / debugging (included in workload)
- Just-In-Time debugger
- C++ profiling tools (pulls in graphics debugging features)
- Profiling tools
- Testing tools core features
- Recommended (other)
- GitHub extension for Visual Studio
- Test Adapter for Google Test
- clang-format 7
- Install a 7.x version of the LLVM tools from http://releases.llvm.org
- In VS options > Text Editor > C/C++ > Formatting > General, enable "Use custom clang-format.exe file" and point it to the binary.
- In VS, Options > Text Editor > C/C++ > Formatting > General, enable "Use custom clang-format.exe file" and point it to the binary.
- You could also use Tools\lint.sh via WSL to execute a linux-native version over the dolphin sources
## Get and Build Dolphin
### Cloning
1. Open the Team Explorer and choose "Clone" under "Local Git Repositories".
2. Enter repository URL as it appears on the [GitHub project page](https://github.com/dolphin-emu/dolphin).
3. Click Clone to start downloading.
4. Protips:
- Enable NTFS compression on the root of your source directory (saves a lot of space with negligible perf overhead).
- Store the sources on the fastest disk as possible (e.g. fast SSD).
You may of course eschew the Visual Studio git integration and use any method of dealing with git outside of Visual Studio.
### Qt Dependencies
* If you want to build the DolphinQt project, you should get the required dependencies from a submodule provided for Dolphin.
- In Team Explorer, go to Changes > Actions > Open Command Prompt and execute `git submodule update --init --recursive`.
* If you do not care about DolphinQt, you can just right click on the project and click "Unload Project".
### Clone
* Windows requires pulling in some submodules, so use `git clone --recursive` to clone dolphin from the main repo or your fork.
### Building
1. Open Source/dolphin-emu.sln.