aboutsummaryrefslogtreecommitdiffhomepage
path: root/INSTALL.md
diff options
context:
space:
mode:
authorBryce Van Dyk <[email protected]>2017-10-25 13:15:13 +1300
committerMatthew Gregan <[email protected]>2017-10-25 13:26:59 +1300
commit6e2280ab52ed497f1d36a79c5932f6a326f7be87 (patch)
treeb9bff3807ea4820ec86d91b292f82a5583ed34c7 /INSTALL.md
parent7c690713f25ce19197cc28cc7241df258fa52889 (diff)
downloadcubeb-6e2280ab52ed497f1d36a79c5932f6a326f7be87.tar.gz
cubeb-6e2280ab52ed497f1d36a79c5932f6a326f7be87.zip
Elaborate the build instructions for Windows
Add mention of visual studio 2017, add instructions on how to use CMake from within VS2017. Point out gotcha of default build dirs in VS2017.
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md34
1 files changed, 28 insertions, 6 deletions
diff --git a/INSTALL.md b/INSTALL.md
index 81df5ea..f849224 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -11,14 +11,36 @@ You must have CMake v3.1 or later installed.
# Windows build notes
-Windows builds can use Microsoft Visual Studio 2015 (the default) or MinGW-w64
-with Win32 threads (by passing `cmake -G` to generate the appropriate build
-configuration). To build with MinGW-w64, install the following items:
+Windows builds can use Microsoft Visual Studio 2015, Microsoft Visual Studio
+2017, or MinGW-w64 with Win32 threads (by passing `cmake -G` to generate the
+appropriate build configuration).
+
+## Microsoft Visual Studio 2015 or 2017 Command Line
+
+CMake can be used from the command line by following the build steps at the top
+of this file. CMake will select a default generator based on the environment,
+or one can be specified with the `-G` argument.
+
+## Microsoft Visual Studio 2017 IDE
+
+Visual Studio 2017 adds in built support for CMake. CMake can be used from
+within the IDE via the following steps:
+
+- Navigate to `File -> Open -> Cmake...`
+- Open `CMakeLists.txt` file in the root of the project.
+
+Note, to generate the build in the cubeb dir CMake settings need to be updated
+via: `CMake -> Change CMake Settings -> CMakeLists.txt`. The default
+configuration used by Visual Studio will place the build in a different location
+than the steps detailed at the top of this file.
+
+## MinGW-w64
+
+To build with MinGW-w64, install the following items:
- Download and install MinGW-w64 with Win32 threads.
- Download and install CMake.
- Run MinGW-w64 Terminal from the Start Menu.
-- Follow the build steps above, but at step 3 run:
+- Follow the build steps at the top of this file, but at step 3 run:
`cmake -G "MinGW Makefiles" ..`
-- Continue the build steps above.
-
+- Continue the build steps at the top of this file.