|
@@ -22,14 +22,22 @@ The goal of the project is to allow the broader community of shader developers t
|
|
|
|
|
|
Before you build, you will need to have some additional software installed.
|
|
Before you build, you will need to have some additional software installed.
|
|
|
|
|
|
-* [Install Git](http://git-scm.com/downloads)
|
|
|
|
-* Visual Studio 2015, Update 3. This will install the Windows Development Kit as a side effect. In the install options, make sure the 10.0.10240.0 SDK is included.
|
|
|
|
|
|
+* [Git](http://git-scm.com/downloads).
|
|
|
|
+* [Visual Studio 2015](https://www.visualstudio.com/downloads). Update 3 is the supported version. This will install the Windows Development Kit as a side effect. We also need the common tools for visual C++ to get the atl headers (e.g. atlbase.h). In the install options, make sure the following options are checked:
|
|
|
|
+ * Windows 10 SDK (10.0.10240.0)
|
|
|
|
+ * Common Tools for Visual C++ 2015
|
|
* [Windows 10 SDK](https://developer.microsoft.com/en-US/windows/downloads/windows-10-sdk). This is needed to build tests that reference the D3D12 runtime.
|
|
* [Windows 10 SDK](https://developer.microsoft.com/en-US/windows/downloads/windows-10-sdk). This is needed to build tests that reference the D3D12 runtime.
|
|
* [Windows Driver Kit](https://developer.microsoft.com/en-us/windows/hardware/windows-driver-kit). Or download and install the [Windows Driver Kit 8.1 Update 1](http://www.microsoft.com/en-us/download/details.aspx?id=42273), no need to download and install tests. This will target your common Windows Kits path, on a 64-bit machine this will likely be C:\Program Files (x86)\Windows Kits\8.1. WDK for Windows 10 should also work. This is currently needed to run TAEF tests and build with the TAEF framework.
|
|
* [Windows Driver Kit](https://developer.microsoft.com/en-us/windows/hardware/windows-driver-kit). Or download and install the [Windows Driver Kit 8.1 Update 1](http://www.microsoft.com/en-us/download/details.aspx?id=42273), no need to download and install tests. This will target your common Windows Kits path, on a 64-bit machine this will likely be C:\Program Files (x86)\Windows Kits\8.1. WDK for Windows 10 should also work. This is currently needed to run TAEF tests and build with the TAEF framework.
|
|
-* [CMake](http://www.cmake.org/download/). [Version 3.4](https://cmake.org/files/v3.4/cmake-3.4.0-win32-x86.exe) is the supported version. You need not change your PATH variable during installation.
|
|
|
|
|
|
+* [CMake](https://cmake.org/files/v3.4/cmake-3.4.3-win32-x86.exe). Version 3.4.3 is the supported version. You need not change your PATH variable during installation.
|
|
* [Python](https://www.python.org/downloads/). Version 2.7.x is required, 3.x might work but it's not officially supported. You need not change your PATH variable during installation.
|
|
* [Python](https://www.python.org/downloads/). Version 2.7.x is required, 3.x might work but it's not officially supported. You need not change your PATH variable during installation.
|
|
|
|
|
|
-To create a shortcut to the build environment, double-click on the utils\hct\hctshortcut.js file.
|
|
|
|
|
|
+To setup the build environment run the `utils\hct\hctstart.cmd` script passing the path to the source and build directories. For example:
|
|
|
|
+
|
|
|
|
+ git clone <DirectXShaderCompiler repo> C:\DirectXShaderCompiler
|
|
|
|
+ cd C:\DirectXShaderCompiler
|
|
|
|
+ utils\hct\hctstart.cmd C:\DirectXShaderCompiler C:\DirectXShaderCompiler.bin
|
|
|
|
+
|
|
|
|
+To create a shortcut to the build environment with the default build directory, double-click on the `utils\hct\hctshortcut.js` file.
|
|
|
|
|
|
To build, open the HLSL Console and run this command.
|
|
To build, open the HLSL Console and run this command.
|
|
|
|
|