diff options
| author | Jeremy Kniager <jeremyk@lunarg.com> | 2019-07-02 13:34:43 -0600 |
|---|---|---|
| committer | jeremyk-lunarg <jeremyk@lunarg.com> | 2019-07-15 10:46:43 -0600 |
| commit | 269e632734962cbebc93d9e88a5de48e18bffad3 (patch) | |
| tree | bc14a73d703e931f455a494cfc66fb927101f839 | |
| parent | 4173f5f87724e486de5fd9fd1d1ff65f53293e48 (diff) | |
| download | usermoji-269e632734962cbebc93d9e88a5de48e18bffad3.tar.xz | |
docs: Improve instructions for using update_deps.
[ci skip]
Same change as KhronosGroup/Vulkan-ValidationLayers#955
Change-Id: Ifdc30a41f4d7f1e4ad9bc887df6f43f5caaa69f9
| -rw-r--r-- | BUILD.md | 31 |
1 files changed, 25 insertions, 6 deletions
@@ -112,22 +112,41 @@ directories and place them in any location. ### Building Dependent Repositories with Known-Good Revisions -There is a Python utility script, `scripts/update_deps.py`, that you can use -to gather and build the dependent repositories mentioned above. This program -also uses information stored in the `scripts/known-good.json` file to checkout -dependent repository revisions that are known to be compatible with the -revision of this repository that you currently have checked out. +There is a Python utility script, `scripts/update_deps.py`, that you can use to +gather and build the dependent repositories mentioned above. This script uses +information stored in the `scripts/known_good.json` file to check out dependent +repository revisions that are known to be compatible with the revision of this +repository that you currently have checked out. As such, this script is useful +as a quick-start tool for common use cases and default configurations. -Here is a usage example for this repository: +For all platforms, start with: git clone git@github.com:KhronosGroup/Vulkan-Tools.git cd Vulkan-Tools mkdir build cd build + +For 64-bit Linux and MacOS, continue with: + ../scripts/update_deps.py cmake -C helper.cmake .. cmake --build . +For 64-bit Windows, continue with: + + ..\scripts\update_deps.py --arch x64 + cmake -A x64 -C helper.cmake .. + cmake --build . + +For 32-bit Windows, continue with: + + ..\scripts\update_deps.py --arch Win32 + cmake -A Win32 -C helper.cmake .. + cmake --build . + +Please see the more detailed build information later in this file if you have +specific requirements for configuring and building these components. + #### Notes - You may need to adjust some of the CMake options based on your platform. See |