|
1 | | -# Build Instructions |
| 1 | +# Build Instructions <!-- omit from toc --> |
2 | 2 |
|
3 | 3 | Instructions for building this repository on Linux, Windows, and MacOS. |
4 | 4 |
|
5 | | -## Table Of Contents |
6 | | - |
7 | | -- [Build Instructions](#build-instructions) |
8 | | - - [Table Of Contents](#table-of-contents) |
9 | | - - [Contributing to the Repository](#contributing-to-the-repository) |
10 | | - - [Repository Content](#repository-content) |
11 | | - - [Installed Files](#installed-files) |
12 | | - - [Build Requirements](#build-requirements) |
13 | | - - [Building with Code Generation Requirements](#building-with-code-generation-requirements) |
14 | | - - [Test Requirements](#test-requirements) |
15 | | - - [Repository Set-Up](#repository-set-up) |
16 | | - - [Display Drivers](#display-drivers) |
17 | | - - [Repository Dependencies](#repository-dependencies) |
18 | | - - [Vulkan-Headers](#vulkan-headers) |
19 | | - - [Test Dependencies](#test-dependencies) |
20 | | - - [Warnings as errors off by default!](#warnings-as-errors-off-by-default) |
21 | | - - [Build and Install Directory Locations](#build-and-install-directory-locations) |
22 | | - - [Building Dependent Repositories with Known-Good Revisions](#building-dependent-repositories-with-known-good-revisions) |
23 | | - - [Automatically](#automatically) |
24 | | - - [Manually](#manually) |
25 | | - - [Notes About the Manual Option](#notes-about-the-manual-option) |
26 | | - - [Generated source code](#generated-source-code) |
27 | | - - [Build Options](#build-options) |
28 | | - - [Building On Windows](#building-on-windows) |
29 | | - - [Windows Development Environment Requirements](#windows-development-environment-requirements) |
30 | | - - [Windows Build - Microsoft Visual Studio](#windows-build---microsoft-visual-studio) |
31 | | - - [Windows Quick Start](#windows-quick-start) |
32 | | - - [Use `CMake` to Create the Visual Studio Project Files](#use-cmake-to-create-the-visual-studio-project-files) |
33 | | - - [Build the Solution From the Command Line](#build-the-solution-from-the-command-line) |
34 | | - - [Build the Solution With Visual Studio](#build-the-solution-with-visual-studio) |
35 | | - - [Windows Install Target](#windows-install-target) |
36 | | - - [Building On Linux](#building-on-linux) |
37 | | - - [Linux Development Environment Requirements](#linux-development-environment-requirements) |
38 | | - - [Required Package List](#required-package-list) |
39 | | - - [Linux Build](#linux-build) |
40 | | - - [Linux Quick Start](#linux-quick-start) |
41 | | - - [Use CMake to Create the Make Files](#use-cmake-to-create-the-make-files) |
42 | | - - [Build the Project](#build-the-project) |
43 | | - - [Linux Notes](#linux-notes) |
44 | | - - [WSI Support Build Options](#wsi-support-build-options) |
45 | | - - [Linux Install to System Directories](#linux-install-to-system-directories) |
46 | | - - [Linux 32-bit support](#linux-32-bit-support) |
47 | | - - [Building on MacOS](#building-on-macos) |
48 | | - - [MacOS Development Environment Requirements](#macos-development-environment-requirements) |
49 | | - - [Clone the Repository](#clone-the-repository) |
50 | | - - [MacOS build](#macos-build) |
51 | | - - [Building with the Unix Makefiles Generator](#building-with-the-unix-makefiles-generator) |
52 | | - - [Building with the Xcode Generator](#building-with-the-xcode-generator) |
53 | | - - [Building on Fuchsia](#building-on-fuchsia) |
54 | | - - [SDK Symbols](#sdk-symbols) |
55 | | - - [Building on QNX](#building-on-qnx) |
56 | | - - [Cross Compilation](#cross-compilation) |
57 | | - - [Unknown function handling which requires explicit assembly implementations](#unknown-function-handling-which-requires-explicit-assembly-implementations) |
58 | | - - [Platforms which fully support unknown function handling](#platforms-which-fully-support-unknown-function-handling) |
59 | | - - [Tests](#tests) |
| 5 | +## Table Of Contents <!-- omit from toc --> |
| 6 | + |
| 7 | +- [Contributing to the Repository](#contributing-to-the-repository) |
| 8 | +- [Repository Content](#repository-content) |
| 9 | + - [Installed Files](#installed-files) |
| 10 | +- [Build Requirements](#build-requirements) |
| 11 | + - [Building with Code Generation Requirements](#building-with-code-generation-requirements) |
| 12 | + - [Test Requirements](#test-requirements) |
| 13 | +- [Repository Set-Up](#repository-set-up) |
| 14 | + - [Display Drivers](#display-drivers) |
| 15 | + - [Repository Dependencies](#repository-dependencies) |
| 16 | + - [Vulkan-Headers](#vulkan-headers) |
| 17 | + - [Test Dependencies](#test-dependencies) |
| 18 | + - [Warnings as errors off by default!](#warnings-as-errors-off-by-default) |
| 19 | + - [Build and Install Directory Locations](#build-and-install-directory-locations) |
| 20 | + - [Building Dependent Repositories with Known-Good Revisions](#building-dependent-repositories-with-known-good-revisions) |
| 21 | + - [Automatically](#automatically) |
| 22 | + - [Manually](#manually) |
| 23 | + - [Notes About the Manual Option](#notes-about-the-manual-option) |
| 24 | + - [Generated source code](#generated-source-code) |
| 25 | + - [Build Options](#build-options) |
| 26 | +- [Building On Windows](#building-on-windows) |
| 27 | + - [Windows Development Environment Requirements](#windows-development-environment-requirements) |
| 28 | + - [Windows Build - Microsoft Visual Studio](#windows-build---microsoft-visual-studio) |
| 29 | + - [Windows Quick Start](#windows-quick-start) |
| 30 | + - [Use `CMake` to Create the Visual Studio Project Files](#use-cmake-to-create-the-visual-studio-project-files) |
| 31 | + - [Build the Solution From the Command Line](#build-the-solution-from-the-command-line) |
| 32 | + - [Build the Solution With Visual Studio](#build-the-solution-with-visual-studio) |
| 33 | + - [Windows Install Target](#windows-install-target) |
| 34 | +- [Building On Linux](#building-on-linux) |
| 35 | + - [Linux Development Environment Requirements](#linux-development-environment-requirements) |
| 36 | + - [Required Package List](#required-package-list) |
| 37 | + - [Linux Build](#linux-build) |
| 38 | + - [Linux Quick Start](#linux-quick-start) |
| 39 | + - [Use CMake to Create the Make Files](#use-cmake-to-create-the-make-files) |
| 40 | + - [Build the Project](#build-the-project) |
| 41 | + - [Linux Notes](#linux-notes) |
| 42 | + - [WSI Support Build Options](#wsi-support-build-options) |
| 43 | + - [Linux Install to System Directories](#linux-install-to-system-directories) |
| 44 | + - [Linux 32-bit support](#linux-32-bit-support) |
| 45 | +- [Building on MacOS](#building-on-macos) |
| 46 | + - [MacOS Development Environment Requirements](#macos-development-environment-requirements) |
| 47 | + - [Clone the Repository](#clone-the-repository) |
| 48 | + - [MacOS build](#macos-build) |
| 49 | + - [Building with the Unix Makefiles Generator](#building-with-the-unix-makefiles-generator) |
| 50 | + - [Building with the Xcode Generator](#building-with-the-xcode-generator) |
| 51 | +- [Building on Fuchsia](#building-on-fuchsia) |
| 52 | + - [SDK Symbols](#sdk-symbols) |
| 53 | +- [Building on QNX](#building-on-qnx) |
| 54 | +- [Cross Compilation](#cross-compilation) |
| 55 | + - [Unknown function handling which requires explicit assembly implementations](#unknown-function-handling-which-requires-explicit-assembly-implementations) |
| 56 | + - [Platforms which fully support unknown function handling](#platforms-which-fully-support-unknown-function-handling) |
| 57 | +- [Tests](#tests) |
60 | 58 |
|
61 | 59 |
|
62 | 60 | ## Contributing to the Repository |
|
0 commit comments