Skip to content

Commit 74c3b54

Browse files
hekotatex3d
authored andcommitted
Update README.md - dxilconv and build setup instructions (#2741)
* Update README.md - dxilconv and build setup instructions
1 parent 2f4f6f6 commit 74c3b54

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ At the moment, the DirectX HLSL Compiler provides the following components:
1717

1818
- dxcompiler.dll, a DLL providing a componentized compiler, assembler, disassembler, and validator
1919

20+
- dxilconv.dll, a DLL providing a converter from DXBC (older shader bytecode format)
21+
2022
- various other tools based on the above components
2123

2224
The Microsoft Windows SDK releases include a supported version of the compiler and validator.
@@ -40,12 +42,16 @@ Note: If you intend to build from sources on Linux/macOS, follow [these instruct
4042
Before you build, you will need to have some additional software installed. This is the most straightforward path - see [Building Sources](https://github.com/Microsoft/DirectXShaderCompiler/wiki/Building-Sources) on the Wiki for more options, including Visual Studio 2015 and Ninja support.
4143

4244
* [Git](http://git-scm.com/downloads).
43-
* [Visual Studio 2017](https://www.visualstudio.com/downloads). Select the following workloads: Universal Windows Platform Development and Desktop Development with C++.
44-
* [Python](https://www.python.org/downloads/). Version 3.x is required.
45+
* [Python](https://www.python.org/downloads/) - version 3.x is required
46+
* [Visual Studio 2017](https://www.visualstudio.com/downloads) - select the following workloads:
47+
* Universal Windows Platform Development
48+
* Desktop Development with C++
49+
* [Windows SDK](https://developer.microsoft.com/en-US/windows/downloads/windows-10-sdk) - version 10.0.18362.0 or newer
50+
* [Windows Driver Kit](https://docs.microsoft.com/en-us/windows-hardware/drivers/download-the-wdk) - same version as the SDK
4551

4652
After cloning the project, you can set up a build environment shortcut by double-clicking the `utils\hct\hctshortcut.js` file. This will create a shortcut on your desktop with a default configuration.
4753

48-
Tests are built using the TAEF framework. Unless you have the Windows Driver Kit installed, you should run the script at `utils\hct\hctgettaef.py` from your build environment before you start building to download and unzip it as an external dependency. You should only need to do this once.
54+
Tests are built using the TAEF framework which is included in the Windows Driver Kit.
4955

5056
To build, run this command on the HLSL Console.
5157

0 commit comments

Comments
 (0)