openharmony/third_party_vulkan-loader
1
0
Fork 0
mirror of https://gitee.com/openharmony/third_party_vulkan-loader synced 2024-11-27 09:21:56 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Fix internal links in BUILD.md

Browse Source
This commit is contained in:
Karl Schultz 2018-04-03 18:28:03 -06:00
parent 19306e828c
commit 79df3f65a7
1 changed files with 11 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
BUILD.md
View File

@ -4,14 +4,12 @@ Instructions for building this repository on Linux, Windows, Android, and MacOS.
## Index
1. [Contributing](#contributing)
2. [Repository Set-Up](#repo-set-up)
3. [Windows Build](#windows-build)
4. [Linux Build](#linux-build)
5. [Android Build](#android-build)
6. [MacOS build](#macos-build)
[](#contributing)
1. [Contributing](#contributing-to-the-repository)
2. [Repository Set-Up](#repository-set-up)
3. [Windows Build](#building-on-windows)
4. [Linux Build](#building-on-linux)
5. [Android Build](#building-on-android)
6. [MacOS build](#building-on-macos)
## Contributing to the Repository
@ -20,8 +18,6 @@ your contribution in a fork of this repository in your GitHub account and
then submit a pull request.
Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file in this repository for more details.
[](#repo-set-up)
## Repository Set-Up
### Display Drivers
@ -36,8 +32,6 @@ To create your local git repository:
git clone https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers
[](#windows-build)
## Building On Windows
### Windows Build Requirements
@ -73,7 +67,7 @@ Windows 7+ with the following software packages:
3. Run `update_external_sources.bat` -- this will download and build external components
4. Create a `build` directory, change into that directory, and run cmake
For example, for VS2017 (generators for other versions are [specified here](#win-cmake-generators)):
For example, for VS2017 (generators for other versions are [specified here](#cmake-visual-studio-generators)):
cmake -G "Visual Studio 15 2017 Win64" ..
@ -87,8 +81,8 @@ to ensure that the program uses the loader built from this solution.
#### The Update External Sources Batch File
Employing [optional parameters to **update_external_sources.bat**](#update-external-sources)
can streamline repository set-up.
Employing [optional parameters](#update-external-sources-optional-parameters)
to the **update_external_sources.bat** script can streamline repository set-up.
### Windows Tests and Demos
@ -131,8 +125,6 @@ Other demos that can be found in the build/demos directory are:
### Windows Notes
[](#win-cmake-generators)
#### CMake Visual Studio Generators
The above example used Visual Studio 2017, and specified its generator as "Visual Studio 15 2017 Win64".
@ -154,8 +146,6 @@ To run Vulkan programs you must tell the Vulkan Loader where to find the librari
This is described in a `LoaderAndLayerInterface` document in the `loader` folder in this repository.
This describes both how ICDs and layers should be properly packaged, and how developers can point to ICDs and layers within their builds.
[](#linux-build)
## Building On Linux
### Linux Build Requirements
@ -188,7 +178,8 @@ If your build system supports ccache, you can enable that via CMake option `-DUS
#### The Update External Sources script
Employing [optional parameters to **update_external_sources.sh**](#update-external-sources) can streamline repository set-up.
Employing [optional parameters](#update-external-sources-optional-parameters)
to the **update_external_sources.sh** script can streamline repository set-up.
#### Using the new loader and layers
@ -333,8 +324,6 @@ to be usable by the rest of the components in the repository.
Finally, rebuild the repository using `cmake` and `make`, as explained above.
[](#android-build)
## Building On Android
Install the required tools for Linux and Windows covered above, then add the following.
@ -488,8 +477,6 @@ To build, install, and run the Smoke demo for Android, run the following, and an
./build-and-install
adb shell am start -a android.intent.action.MAIN -c android-intent.category.LAUNCH -n com.example.Smoke/android.app.NativeActivity --es args "--validate"
[](#macos-build)
## Building on MacOS
### MacOS Build Requirements
@ -650,8 +637,6 @@ files to be used as project files for QtCreator
Note that installing the WDK breaks the MSVC vcvarsall.bat build scripts provided by MSVC,
requiring that the LIB, INCLUDE, and PATHenv variables be set to the WDK paths by some other means
[](#update-external-sources)
## Update External Sources Optional Parameters
This script will default to building 64-bit _and_ 32-bit versions of debug _and_ release