## Index
-1. [Contributing](#contributing)
-2. [Repository Set-Up](#repo-set-up)
-3. [Windows Build](#windows-build)
-4. [Linux Build](#linux-build)
-5. [Android Build](#android-build)
-6. [MacOS build](#macos-build)
-
-[](#contributing)
+1. [Contributing](#contributing-to-the-repository)
+2. [Repository Set-Up](#repository-set-up)
+3. [Windows Build](#building-on-windows)
+4. [Linux Build](#building-on-linux)
+5. [Android Build](#building-on-android)
+6. [MacOS build](#building-on-macos)
## Contributing to the Repository
then submit a pull request.
Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file in this repository for more details.
-[](#repo-set-up)
-
## Repository Set-Up
### Display Drivers
git clone https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers
-[](#windows-build)
-
## Building On Windows
### Windows Build Requirements
3. Run `update_external_sources.bat` -- this will download and build external components
4. Create a `build` directory, change into that directory, and run cmake
-For example, for VS2017 (generators for other versions are [specified here](#win-cmake-generators)):
+For example, for VS2017 (generators for other versions are [specified here](#cmake-visual-studio-generators)):
cmake -G "Visual Studio 15 2017 Win64" ..
#### The Update External Sources Batch File
-Employing [optional parameters to **update_external_sources.bat**](#update-external-sources)
-can streamline repository set-up.
+Employing [optional parameters](#update-external-sources-optional-parameters)
+to the **update_external_sources.bat** script can streamline repository set-up.
### Windows Tests and Demos
### Windows Notes
-[](#win-cmake-generators)
-
#### CMake Visual Studio Generators
The above example used Visual Studio 2017, and specified its generator as "Visual Studio 15 2017 Win64".
This is described in a `LoaderAndLayerInterface` document in the `loader` folder in this repository.
This describes both how ICDs and layers should be properly packaged, and how developers can point to ICDs and layers within their builds.
-[](#linux-build)
-
## Building On Linux
### Linux Build Requirements
#### The Update External Sources script
-Employing [optional parameters to **update_external_sources.sh**](#update-external-sources) can streamline repository set-up.
+Employing [optional parameters](#update-external-sources-optional-parameters)
+to the **update_external_sources.sh** script can streamline repository set-up.
#### Using the new loader and layers
Finally, rebuild the repository using `cmake` and `make`, as explained above.
-[](#android-build)
-
## Building On Android
Install the required tools for Linux and Windows covered above, then add the following.
./build-and-install
adb shell am start -a android.intent.action.MAIN -c android-intent.category.LAUNCH -n com.example.Smoke/android.app.NativeActivity --es args "--validate"
-[](#macos-build)
-
## Building on MacOS
### MacOS Build Requirements
Note that installing the WDK breaks the MSVC vcvarsall.bat build scripts provided by MSVC,
requiring that the LIB, INCLUDE, and PATHenv variables be set to the WDK paths by some other means
-[](#update-external-sources)
-
## Update External Sources Optional Parameters
This script will default to building 64-bit _and_ 32-bit versions of debug _and_ release