Updated with CMake and Qt5 instructions

Yuri Kunde Schlesner 2014-09-01 21:15:31 -07:00
parent 56c9a0e01c
commit f5de687393

@ -1,24 +1,24 @@
### Minimal Dependencies
On Windows, all light-weight dependencies are automatically included within the "externals" folder. To build the minimalist Citra (no Qt debugger), you simply need to install:
* **Git** - I recommend [msysgit](http://msysgit.github.io/). After you've installed it, you need to have the [setup your system path](http://www.java.com/en/download/help/path.xml) to include Git (this is used to generate the scm_rev.cpp file) To do this:
* Right-click "Computer" and select Properties
* On the left-side menu, click "Advanced System Settings"
* On the "Advanced" tab of the "System Properties" window that appears, click the "Environment Variables" button
* In the "System Variables" list-box, find "PATH" and click the "Edit" button
* In the "Edit System Variable" window that appears, append "C:\msysgit\bin;C:\msysgit\mingw\bin;C:\msysgit\cmd;" (or wherever Git is installed on your machine) to the end of list of paths
* Click "OK", "OK", "OK"
* Open the command-prompt, and verify that if you enter "git --version", it says something like "git version 1.9.2.msysgit.0" (your version may be different, that's ok!)
* **[Visual Studio 2013 Express (Windows Desktop)](http://www.microsoft.com/en-us/download/details.aspx?%0Aid=40787)** - NOTE: Must be the "Windows Desktop" one, as the "Windows" one requires Windows 8 / metro mode
* **[CMake](http://www.cmake.org/cmake/resources/software.html)** - Used to generate Visual Studio project files.
* **Git** - I recommend [msysgit](http://msysgit.github.io/). While installing it, you can tell it to include Git in your system path. (Choose the "Use Git from the Windows Command Prompt" option.) If you missed that, don't worry, you'll just have to manually tell CMake where your git executable is, since it's used to include version info into the built executable.
### Debugger Dependencies
For the debugger/Qt GUI, you'll to install [Qt 4.8.6](http://download.qt-project.org/official_releases/qt/4.8/4.8.6/qt-opensource-windows-x86-vs2010-4.8.6.exe):
For the debugger/Qt GUI, you'll need to install [Qt 5.3.1](http://qt-project.org/downloads):
* Download the Qt SDK (1 GB, less when using the online installer) and install it. The only required component is Desktop Qt 4.8.6, but you'll also need Qt Designer if you want to modify Citra's user interface. Furthermore, Qt Examples, Qt SDK Documentation and Qt Assistant are quite useful for developing Qt applications.
* Set your QTDIR environment variable to the directory which contains the bin, include and lib folders (e.g. C:\Qt\4.8.6)
* For running Citra builds, you'll need to have QtCore4.dll and QtGui4.dll in either the application directory or in the system PATH.
* Download the Qt Online installer and launch it. When asked which components to install, select the *msvc2013 OpenGL* version for the processor architecture of your choice. (Be careful to use the OpenGL versions, or Citra will fail to initialize.) You might also want to install Qt Designer if you plan on modifying Citra's user interface.
* Optionally, set your QTDIR environment variable to the directory which contains the bin, include and lib folders. (e.g. C:\Qt\5.3\msvc2013_opengl) This will avoid the need to manually set them in CMake.
* For running Citra builds, you'll need to have icudt52.dll, icuin52.dll icuuc52.dll, Qt5Core.dll, Qt5Gui.dll, Qt5OpenGL.dll and Qt5Widgets.dll in either the application directory or in the system PATH. For debug builds use the dlls with a 'd' appended to the name. (e.g. Qt5Cored.dll)
### Building
* Open cmake-gui and point it to the Citra source code.
* For the build directory, use a `build/` subdirectory inside the source directory or some other directory of your choice. (Tell CMake to create it.)
* Click the "Configure" button and choose "Visual Studio 12 2013" or "Visual Studio 12 2013 Win64".
* Check if CMake detected all libraries and paths correctly and, if necessary, make any adjustments and click "Configure" again.
* Qt 5.3.0 is known to fail at this step. Make sure you have 5.3.1.
* Click "Generate" to create the project files.
* Open the solution file (citra.sln) in Visual Studio 2013
* If you're just building minimalist Citra (and don't care about debugger), right-click the "citra_qt" project from "Solution Explorer" and click "Unload Project". This will cause the Qt frontend not to be built, which is helpful if you don't have Qt installed.
* Click "Build"->"Rebuild Solution"
* Depending on which frontend (GLFW or Qt) you want to build or run, select "citra" or "citra-qt" in the Solution Explorer, right-click and "Set as StartUp Project".
* Press F5 or select Build → Rebuild Solution in the menu.