docs: Improve instructions for using update_deps.
authorJeremy Kniager <jeremyk@lunarg.com>
Tue, 2 Jul 2019 19:34:43 +0000 (13:34 -0600)
committerjeremyk-lunarg <jeremyk@lunarg.com>
Mon, 15 Jul 2019 16:46:43 +0000 (10:46 -0600)
[ci skip]

Same change as KhronosGroup/Vulkan-ValidationLayers#955

Change-Id: Ifdc30a41f4d7f1e4ad9bc887df6f43f5caaa69f9

BUILD.md

index 9b6aaba..b3bd283 100644 (file)
--- a/BUILD.md
+++ b/BUILD.md
@@ -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