3 Instructions for building this repository on Linux, Windows, Android, and MacOS.
7 1. [Contributing](#contributing-to-the-repository)
8 2. [Repository Set-Up](#repository-set-up)
9 3. [Windows Build](#building-on-windows)
10 4. [Linux Build](#building-on-linux)
11 5. [Android Build](#building-on-android)
12 6. [MacOS build](#building-on-macos)
14 ## Contributing to the Repository
16 If you intend to contribute, the preferred work flow is for you to develop
17 your contribution in a fork of this repository in your GitHub account and
18 then submit a pull request.
19 Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file in this repository for more details.
25 This repository does not contain a Vulkan-capable driver.
26 Before proceeding, it is strongly recommended that you obtain a Vulkan driver from your
27 graphics hardware vendor and install it properly.
29 ### Download the Repository
31 To create your local git repository:
33 git clone https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers
35 ## Building On Windows
37 ### Windows Build Requirements
39 Windows 7+ with the following software packages:
41 - Microsoft Visual Studio 2013 Update 4 Professional, VS2015 (any version), or VS2017 (any version).
42 - [CMake](http://www.cmake.org/download/)
43 - Tell the installer to "Add CMake to the system PATH" environment variable.
44 - [Python 3](https://www.python.org/downloads)
45 - Select to install the optional sub-package to add Python to the system PATH
47 - Ensure the `pip` module is installed (it should be by default)
48 - Python3.3 or later is necessary for the Windows py.exe launcher that is used to select python3
49 rather than python2 if both are installed
50 - [Git](http://git-scm.com/download/win)
51 - Tell the installer to allow it to be used for "Developer Prompt" as well as "Git Bash".
52 - Tell the installer to treat line endings "as is" (i.e. both DOS and Unix-style line endings).
53 - Install both the 32-bit and 64-bit versions, as the 64-bit installer does not install the
54 32-bit libraries and tools.
55 - Notes for using [Cygwin](https://www.cygwin.com)
56 - First, in a Cygwin shell:
57 - `./update_external_sources.sh --no-build`
58 - Then, in a Visual Studio Developer Command Prompt:
59 - Ensure python3.x and CMake in are in the path
60 - Run `update_external_sources.bat --no-sync`
61 - Run build_windows_targets.bat cmake
63 ### Windows Build - Microsoft Visual Studio
65 1. Open a Developer Command Prompt for VS201x
66 2. Change directory to `Vulkan-LoaderAndValidationLayers` -- the root of the cloned git repository
67 3. Run `update_external_sources.bat` -- this will download and build external components
68 4. Create a `build` directory, change into that directory, and run cmake
70 For example, for VS2017 (generators for other versions are [specified here](#cmake-visual-studio-generators)):
72 cmake -G "Visual Studio 15 2017 Win64" ..
74 This will create a Windows solution file named `VULKAN.sln` in the build directory.
76 Launch Visual Studio and open the "VULKAN.sln" solution file in the build folder.
77 You may select "Debug" or "Release" from the Solution Configurations drop-down list.
78 Start a build by selecting the Build->Build Solution menu item.
79 This solution copies the loader it built to each program's build directory
80 to ensure that the program uses the loader built from this solution.
82 #### The Update External Sources Batch File
84 Employing [optional parameters](#update-external-sources-optional-parameters)
85 to the **update_external_sources.bat** script can streamline repository set-up.
87 ### Windows Tests and Demos
89 After making any changes to the repository, you should perform some quick sanity tests,
90 including the run_all_tests Powershell script and the cube demo with validation enabled.
92 To run the validation test script, open a Powershell Console,
93 change to the build/tests directory, and run:
101 .\run_all_tests.ps1 -Debug
103 This script will run the following tests:
105 - `vk_loader_validation_tests`:
106 Vulkan loader handle wrapping, allocation callback, and loader/layer interface tests
107 - `vk_layer_validation_tests`:
108 Test Vulkan validation layers
109 - `vkvalidatelayerdoc`:
110 Tests that validation database is up-to-date and is synchronized with the validation source code
112 To run the Cube demo with validation in a Debug build configuration:
114 - In the MSVC solution explorer, right-click on the `cube` project and select
115 `Set As Startup Project`
116 - Right click on cube again, select properties->Debugging->Command Arguments, change to
117 `--validate`, and save
118 - From the main menu, select Debug->Start Debugging, or from the toolbar click
119 `Local Windows Debugger`
121 Other demos that can be found in the build/demos directory are:
123 - `vulkaninfo`: Report GPU properties
124 - `smoketest`: A "smoke" test using more complex Vulkan rendering
128 #### CMake Visual Studio Generators
130 The above example used Visual Studio 2017, and specified its generator as "Visual Studio 15 2017 Win64".
131 The chosen generator should match your Visual Studio version. Appropriate Visual Studio generators include:
133 | Build Platform | 64-bit Generator | 32-bit Generator |
134 |------------------------------|-------------------------------|-------------------------|
135 | Microsoft Visual Studio 2013 | "Visual Studio 12 2013 Win64" | "Visual Studio 12 2013" |
136 | Microsoft Visual Studio 2015 | "Visual Studio 14 2015 Win64" | "Visual Studio 14 2015" |
137 | Microsoft Visual Studio 2017 | "Visual Studio 15 2017 Win64" | "Visual Studio 15 2017" |
139 #### The Vulkan Loader Library
141 Vulkan programs must be able to find and use the vulkan-1.dll library.
142 While several of the test and demo projects in the Windows solution set this up automatically, doing so manually may be necessary for custom projects or solutions.
143 Make sure the library is either installed in the C:\Windows\System32 folder, or that the PATH environment variable includes the folder where the library resides.
145 To run Vulkan programs you must tell the Vulkan Loader where to find the libraries.
146 This is described in a `LoaderAndLayerInterface` document in the `loader` folder in this repository.
147 This describes both how ICDs and layers should be properly packaged, and how developers can point to ICDs and layers within their builds.
151 ### Linux Build Requirements
153 This repository has been built and tested on the two most recent Ubuntu LTS versions.
154 Currently, the oldest supported version is Ubuntu 14.04, meaning that the minimum supported compiler versions are GCC 4.8.2 and Clang 3.4, although earlier versions may work.
155 It should be straightforward to adapt this repository to other Linux distributions.
157 **Required Package List:**
159 sudo apt-get install git cmake build-essential libx11-xcb-dev libxkbcommon-dev libmirclient-dev libwayland-dev libxrandr-dev
163 Example debug build (Note that the update\_external\_sources script used below builds external tools into predefined locations.
164 See **Loader and Validation Layer Dependencies** for more information and other options):
166 1. In a Linux terminal, `cd Vulkan-LoaderAndValidationLayers` -- the root of the
167 cloned git repository
168 2. Execute `./update_external_sources.sh` -- this will download and build external components
169 3. Create a `build` directory, change into that directory, and run cmake:
173 cmake -DCMAKE_BUILD_TYPE=Debug ..
175 4. Run `make -j8` to begin the build
177 If your build system supports ccache, you can enable that via CMake option `-DUSE_CCACHE=On`
179 #### The Update External Sources script
181 Employing [optional parameters](#update-external-sources-optional-parameters)
182 to the **update_external_sources.sh** script can streamline repository set-up.
184 #### Using the new loader and layers
186 export LD_LIBRARY_PATH=<path to your repository root>/build/loader
187 export VK_LAYER_PATH=<path to your repository root>/build/layers
189 You can run the `vulkaninfo` application to see which driver, loader and layers are being used.
191 The `LoaderAndLayerInterface` document in the `loader` folder in this repository
192 is a specification that describes both how ICDs and layers should be properly packaged,
193 and how developers can point to ICDs and layers within their builds.
195 ### WSI Support Build Options
197 By default, the Vulkan Loader and Validation Layers are built with support for all 4 Vulkan-defined WSI display servers: Xcb, Xlib, Wayland, and Mir.
198 It is recommended to build the repository components with support for these display servers to maximize their usability across Linux platforms.
199 If it is necessary to build these modules without support for one of the display servers, the appropriate CMake option of the form `BUILD_WSI_xxx_SUPPORT` can be set to `OFF`.
200 See the top-level CMakeLists.txt file for more info.
202 ### Linux Install to System Directories
204 Installing the files resulting from your build to the systems directories is optional since environment variables can usually be used instead to locate the binaries.
205 There are also risks with interfering with binaries installed by packages.
206 If you are certain that you would like to install your binaries to system directories, you can proceed with these instructions.
208 Assuming that you've built the code as described above and the current directory is still `build`, you can execute:
212 This command installs files to:
214 - `/usr/local/include/vulkan`: Vulkan include files
215 - `/usr/local/lib`: Vulkan loader and layers shared objects
216 - `/usr/local/bin`: vulkaninfo application
217 - `/usr/local/etc/vulkan/explicit_layer.d`: Layer JSON files
219 You may need to run `ldconfig` in order to refresh the system loader search cache on some Linux systems.
221 You can further customize the installation location by setting additional CMake variables to override their defaults.
222 For example, if you would like to install to `/tmp/build` instead of `/usr/local`, on your CMake command line specify:
224 -DCMAKE_INSTALL_PREFIX=/tmp/build
225 -DDEST_DIR=/tmp/build
227 Then run `make install` as before. The install step places the files in `/tmp/build`.
229 Using the `CMAKE_INSTALL_PREFIX` to customize the install location also modifies
230 the loader search paths to include searching for layers in the specified install location.
231 In this example, setting `CMAKE_INSTALL_PREFIX` to `/tmp/build` causes the loader to search
232 `/tmp/build/etc/vulkan/explicit_layer.d` and `/tmp/build/share/vulkan/explicit_layer.d`
233 for the layer JSON files.
234 The loader also searches the "standard" system locations of `/etc/vulkan/explicit_layer.d` and
235 `/usr/share/vulkan/explicit_layer.d` after searching the two locations under `/tmp/build`.
237 You can further customize the installation directories by using the CMake variables
238 `CMAKE_INSTALL_SYSCONFDIR` to rename the `etc` directory and `CMAKE_INSTALL_DATADIR`
239 to rename the `share` directory.
241 See the CMake documentation for more details on using these variables
242 to further customize your installation.
244 Also see the `LoaderAndLayerInterface` document in the `loader` folder in this
245 repository for more information about loader operation.
247 Note that some executables in this repository (e.g., `cube`) use the "rpath" linker directive to
248 load the Vulkan loader from the build directory, `build` in this example.
249 This means that even after installing the loader to the system directories, these executables still
250 use the loader from the build directory.
254 To uninstall the files from the system directories, you can execute:
258 ### Linux Tests and Demos
260 After making any changes to the repository, you should perform some quick sanity tests, including
261 the run_all_tests shell script and the cube demo with validation enabled.
263 To run the **validation test script**, in a terminal change to the build/tests directory and run:
265 VK_LAYER_PATH=../layers ./run_all_tests.sh
267 This script will run the following tests:
269 - `vk_loader_validation_tests`: Tests Vulkan Loader handle wrapping
270 - `vk_layer_validation_tests`: Test Vulkan validation layers
271 - `vkvalidatelayerdoc`: Tests that validation database is in up-to-date and in synchronization with
272 the validation source code
274 To run the **Cube demo** with validation, in a terminal change to the `build/demos`
277 VK_LAYER_PATH=../layers ./cube --validate
279 Other demos that can be found in the `build/demos` directory are:
281 - `vulkaninfo`: report GPU properties
282 - `smoketest`: A "smoke" test using more complex Vulkan rendering
284 You can select which WSI subsystem is used to build the demos using a CMake option
285 called DEMOS_WSI_SELECTION.
286 Supported options are XCB (default), XLIB, WAYLAND, and MIR.
287 Note that you must build using the corresponding BUILD_WSI_*_SUPPORT enabled at the
288 base repository level (all SUPPORT options are ON by default).
289 For instance, creating a build that will use Xlib to build the demos,
290 your CMake command line might look like:
292 cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=Debug -DDEMOS_WSI_SELECTION=XLIB
296 #### Linux 32-bit support
298 Usage of this repository's contents in 32-bit Linux environments is not officially supported.
299 However, since this repository is supported on 32-bit Windows,
300 these modules should generally work on 32-bit Linux.
302 Here are some notes for building 32-bit targets on a 64-bit Ubuntu "reference" platform:
304 If not already installed, install the following 32-bit development libraries:
306 `gcc-multilib g++-multilib libx11-dev:i386`
308 This list may vary depending on your distribution and which windowing systems you are building for.
310 Set up your environment for building 32-bit targets:
315 export PKG_CONFIG_LIBDIR=/usr/lib/i386-linux-gnu
317 Again, your PKG_CONFIG configuration may be different, depending on your distribution.
319 If the libraries in the `external` directory have already been built for 64-bit targets,
320 delete or "clean" this directory and rebuild it with the above settings using the
321 `update_external_sources` shell script.
322 This is required because the libraries in `external` must be built for 32-bit in order
323 to be usable by the rest of the components in the repository.
325 Finally, rebuild the repository using `cmake` and `make`, as explained above.
327 ## Building On Android
329 Install the required tools for Linux and Windows covered above, then add the following.
331 ### Android Build Requirements
333 - Install [Android Studio 2.3](https://developer.android.com/studio/index.html) or later.
334 - From the "Welcome to Android Studio" splash screen, add the following components using
335 Configure > SDK Manager:
336 - SDK Platforms > Android 6.0 and newer
337 - SDK Tools > Android SDK Build-Tools
338 - SDK Tools > Android SDK Platform-Tools
339 - SDK Tools > Android SDK Tools
342 #### Add Android specifics to environment
344 For each of the below, you may need to specify a different build-tools version, as Android Studio will roll it forward fairly regularly.
348 export ANDROID_SDK_HOME=$HOME/Android/sdk
349 export ANDROID_NDK_HOME=$HOME/Android/sdk/ndk-bundle
350 export PATH=$ANDROID_SDK_HOME:$PATH
351 export PATH=$ANDROID_NDK_HOME:$PATH
352 export PATH=$ANDROID_SDK_HOME/build-tools/23.0.3:$PATH
356 set ANDROID_SDK_HOME=%LOCALAPPDATA%\Android\sdk
357 set ANDROID_NDK_HOME=%LOCALAPPDATA%\Android\sdk\ndk-bundle
358 set PATH=%LOCALAPPDATA%\Android\sdk\ndk-bundle;%PATH%
362 export ANDROID_SDK_HOME=$HOME/Library/Android/sdk
363 export ANDROID_NDK_HOME=$HOME/Library/Android/sdk/ndk-bundle
364 export PATH=$ANDROID_NDK_PATH:$PATH
365 export PATH=$ANDROID_SDK_HOME/build-tools/23.0.3:$PATH
367 Note: If `jarsigner` is missing from your platform, you can find it in the
368 Android Studio install or in your Java installation.
369 If you do not have Java, you can get it with something like the following:
371 sudo apt-get install openjdk-8-jdk
373 #### Additional OSX System Requirements
375 Tested on OSX version 10.13.3
377 Setup Homebrew and components
379 - Follow instructions on [brew.sh](http://brew.sh) to get Homebrew installed.
381 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
383 - Ensure Homebrew is at the beginning of your PATH:
385 export PATH=/usr/local/bin:$PATH
387 - Add packages with the following:
389 brew install cmake python
393 There are two options for building the Android layers.
394 Either using the SPIRV tools provided as part of the Android NDK, or using upstream sources.
395 To build with SPIRV tools from the NDK, remove the build-android/third_party directory created by
396 running update_external_sources_android.sh, (or avoid running update_external_sources_android.sh).
397 Use the following script to build everything in the repository for Android, including validation
398 layers, tests, demos, and APK packaging: This script does retrieve and use the upstream SPRIV tools.
403 Resulting validation layer binaries will be in build-android/libs.
404 Test and demo APKs can be installed on production devices with:
406 ./install_all.sh [-s <serial number>]
408 Note that there are no equivalent scripts on Windows yet, that work needs to be completed.
409 The following per platform commands can be used for layer only builds:
413 Follow the setup steps for Linux or OSX above, then from your terminal:
416 ./update_external_sources_android.sh --no-build
417 ./android-generate.sh
422 Follow the setup steps for Windows above, then from Developer Command Prompt for VS2013:
425 update_external_sources_android.bat
429 ### Android Tests and Demos
431 After making any changes to the repository you should perform some quick sanity tests,
432 including the layer validation tests and the cube and smoke demos with validation enabled.
434 #### Run Layer Validation Tests
436 Use the following steps to build, install, and run the layer validation tests for Android:
440 adb install -r bin/VulkanLayerValidationTests.apk
441 adb shell am start com.example.VulkanLayerValidationTests/android.app.NativeActivity
443 Alternatively, you can use the test_APK script to install and run the layer validation tests:
445 test_APK.sh -s <serial number> -p <plaform name> -f <gtest_filter>
447 #### Run Cube and Smoke with Validation
449 Use the following steps to build, install, and run Cube and Smoke for Android:
453 adb install -r ../demos/android/cube/bin/cube.apk
454 adb shell am start com.example.Cube/android.app.NativeActivity
456 To build, install, and run Cube with validation layers,
457 first build layers using steps above, then run:
461 adb install -r ../demos/android/cube-with-layers/bin/cube-with-layers.apk
463 ##### Run without validation enabled
465 adb shell am start com.example.CubeWithLayers/android.app.NativeActivity
467 ##### Run with validation enabled
469 adb shell am start -a android.intent.action.MAIN -c android-intent.category.LAUNCH -n com.example.CubeWithLayers/android.app.NativeActivity --es args "--validate"
471 To build, install, and run the Smoke demo for Android, run the following, and any prompts that come back from the script:
473 ./update_external_sources.sh --glslang
474 cd demos/smoke/android
475 export ANDROID_SDK_HOME=<path to Android/Sdk>
476 export ANDROID_NDK_HOME=<path to Android/Sdk/ndk-bundle>
478 adb shell am start -a android.intent.action.MAIN -c android-intent.category.LAUNCH -n com.example.Smoke/android.app.NativeActivity --es args "--validate"
482 ### MacOS Build Requirements
484 Tested on OSX version 10.12.6
486 Setup Homebrew and components
488 - Follow instructions on [brew.sh](http://brew.sh) to get Homebrew installed.
490 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
492 - Ensure Homebrew is at the beginning of your PATH:
494 export PATH=/usr/local/bin:$PATH
496 - Add packages with the following (may need refinement)
498 brew install cmake python python3 git
500 ### Clone the Repository
502 Clone the Vulkan-LoaderAndValidationLayers repository:
504 git clone https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers.git
506 ### Get the External Libraries
508 Change to the cloned directory (`cd Vulkan-LoaderAndValidationLayers`) and run the script:
510 ./update_external_sources.sh
512 This script downloads and builds the `glslang` and `MoltenVK` repositories.
516 #### CMake Generators
518 This repository uses CMake to generate build or project files that are
519 then used to build the repository.
520 The CMake generators explicitly supported in this repository are:
525 #### Building with the Unix Makefiles Generator
527 This generator is the default generator, so all that is needed for a debug
532 cmake -DCMAKE_BUILD_TYPE=Debug ..
535 To speed up the build on a multi-core machine, use the `-j` option for `make`
536 to specify the number of cores to use for the build.
541 You can now run the demo applications from the command line:
544 open demos/cubepp.app
545 open demos/smoketest.app
546 open demos/vulkaninfo.app
548 Or you can locate them from `Finder` and launch them from there.
550 ##### The Install Target and RPATH
552 The applications you just built are "bundled applications", but the executables
553 are using the `RPATH` mechanism to locate runtime dependencies that are still
556 To see this, run this command from your `build` directory:
558 otool -l demos/cube.app/Contents/MacOS/cube
560 and note that the `cube` executable contains loader commands:
562 - `LC_LOAD_DYLIB` to load `libvulkan.1.dylib` via an `@rpath`
563 - `LC_RPATH` that contains an absolute path to the build location of the Vulkan loader
565 This makes the bundled application "non-transportable", meaning that it won't run
566 unless the Vulkan loader is on that specific absolute path.
567 This is useful for debugging the loader or other components built in this repository,
568 but not if you want to move the application to another machine or remove your build tree.
570 To address this problem, run:
574 This step "cleans up" the `RPATH` to remove any external references
575 and performs other bundle fix-ups.
576 After running `make install`, re-run the `otool` command again and note:
578 - `LC_LOAD_DYLIB` is now `@executable_path/../MacOS/libvulkan.1.dylib`
579 - `LC_RPATH` is no longer present
581 The "bundle fix-up" operation also puts a copy of the Vulkan loader into the bundle,
582 making the bundle completely self-contained and self-referencing.
584 Note that the "install" target has a very different meaning compared to the Linux
585 "make install" target.
586 The Linux "install" copies the targets to system directories.
587 In MacOS, "install" means fixing up application bundles.
588 In both cases, the "install" target operations clean up the `RPATH`.
590 ##### The Non-bundled vulkaninfo Application
592 There is also a non-bundled version of the `vulkaninfo` application that you can
593 run from the command line:
597 If you run this before you run "make install", vulkaninfo's RPATH is already set
598 to point to the Vulkan loader in the build tree, so it has no trouble finding it.
599 But the loader will not find the MoltenVK driver and you'll see a message about an
600 incompatible driver. To remedy this:
602 VK_ICD_FILENAMES=../external/MoltenVK/Package/Latest/MoltenVK/macOS/MoltenVK_icd.json demos/vulkaninfo
604 If you run `vulkaninfo` after doing a "make install", the `RPATH` in the `vulkaninfo` application
605 got removed and the OS needs extra help to locate the Vulkan loader:
607 DYLD_LIBRARY_PATH=loader VK_ICD_FILENAMES=../external/MoltenVK/Package/Latest/MoltenVK/macOS/MoltenVK_icd.json demos/vulkaninfo
609 #### Building with the Xcode Generator
611 To create and open an Xcode project:
616 open VULKAN.xcodeproj
618 Within Xcode, you can select Debug or Release builds in the project's Build Settings.
619 You can also select individual schemes for working with specific applications like `cube`.
621 ## Ninja Builds - All Platforms
623 The [Qt Creator IDE](https://qt.io/download-open-source/#section-2) can open a root CMakeList.txt
624 as a project directly, and it provides tools within Creator to configure and generate Vulkan SDK
625 build files for one to many targets concurrently.
626 Alternatively, when invoking CMake, use the `-G "Codeblocks - Ninja"` option to generate Ninja build
627 files to be used as project files for QtCreator
629 - Follow the steps defined elsewhere for the OS using the update\_external\_sources script or as
630 shown in **Loader and Validation Layer Dependencies** below
631 - Open, configure, and build the glslang CMakeList.txt files. Note that building the glslang
632 project will provide access to spirv-tools and spirv-headers
633 - Then do the same with the Vulkan-LoaderAndValidationLayers CMakeList.txt file
634 - In order to debug with QtCreator, a
635 [Microsoft WDK: eg WDK 10](http://go.microsoft.com/fwlink/p/?LinkId=526733) is required.
637 Note that installing the WDK breaks the MSVC vcvarsall.bat build scripts provided by MSVC,
638 requiring that the LIB, INCLUDE, and PATHenv variables be set to the WDK paths by some other means
640 ## Update External Sources Optional Parameters
642 This script will default to building 64-bit _and_ 32-bit versions of debug _and_ release
643 configurations, which can take a substantial amount of time.
644 However, it supports the following options to select a particular build configuration which can
645 reduce the time needed for repository set-up:
647 | Command Line Option | Function |
648 |----------------------|----------------------------------------------|
649 | --32 | Build 32-bit targets only |
650 | --64 | Build 64-bit targets only |
651 | --release | Perform release builds only |
652 | --debug | Perform debug builds only |
653 | --no-build | Sync without building targets |
654 | --no-sync | Skip repository sync step |
656 For example, to target a Windows 64-bit debug development configuration, invoke the batch file as follows:
658 `update_external_sources.bat --64 --debug`
660 Similarly, invoking the same configuration for Linux would be:
662 `update_external_sources.sh --64 --debug`
664 ## Loader and Validation Layer Dependencies
666 The glslang repository is required to build and run Loader and Validation Layer components.
667 It is not a git sub-module of Vulkan-LoaderAndValidationLayers but Vulkan-LoaderAndValidationLayers
668 is linked to a specific revision of glslang.
669 This can be automatically cloned and built to predefined locations with the
670 `update_external_sources` scripts.
671 If a custom configuration is required, do the following steps:
673 1) clone the repository:
675 `git clone https://github.com/KhronosGroup/glslang.git`
677 2) checkout the correct version of the tree based on the contents of the
678 glslang\_revision file at the root of the Vulkan-LoaderAndValidationLayers tree
679 (do the same anytime that Vulkan-LoaderAndValidationLayers is updated from remote)
684 git checkout < [path to Vulkan-LoaderAndValidationLayers]\glslang_revision [in glslang repo]
690 git checkout `cat [path to Vulkan-LoaderAndValidationLayers]\glslang_revision` [in glslang repo]
693 3) Configure the glslang source tree with CMake and build it with your IDE of choice
695 4) Enable the `CUSTOM_GLSLANG_BIN_PATH` and `CUSTOM_SPIRV_TOOLS_BIN_PATH` options in the Vulkan-LoaderAndValidationLayers
696 CMake configuration and point the `GLSLANG_BINARY_PATH` and `SPIRV_TOOLS_BINARY_PATH` variables to the correct location
698 5) If building on Windows with MSVC, set `DISABLE_BUILDTGT_DIR_DECORATION` to _On_.
699 If building on Windows, but without MSVC set `DISABLE_BUILD_PATH_DECORATION` to _On_
701 ## Optional software packages
703 - [Cygwin for windows](https://www.cygwin.com/)
704 - Cygwin provides some Linux-like tools, which can be valuable for working with the repository,
705 such as the BASH shell and git packages
706 - With appropriate adjustments, it is possible to use other shells and environments as well
708 - [Ninja on all platforms](https://github.com/ninja-build/ninja/releases)
709 - [The Ninja-build project](https://ninja-build.org)
710 - [Ninja Users Manual](https://ninja-build.org/manual.html)
712 - [QtCreator as IDE for CMake builds on all platforms](https://qt.io/download-open-source/#section-2)