mirror/Vulkan-Hpp
1
0
Fork 0
mirror of https://github.com/KhronosGroup/Vulkan-Hpp.git synced 2024-10-14 16:32:17 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Slightly simplified setup instructions

Browse Source 
On one hand the erradication of a step simplifies the whole procedure, on the other removing the non-functional `-G` template will allow simply copy & pasting the entire command without any need for modifications since `-G` isn't explicitely required most of the time.
This commit is contained in:
Stefan 2021-11-12 03:08:52 +01:00 committed by GitHub
parent f681e8b909
commit dc6858d193
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -29,13 +29,12 @@ To build the local samples and tests you'll have to clone this repository and ru
1. Open a shell which provides git and clone the repository with: 1. Open a shell which provides git and clone the repository with:
```git clone --recurse-submodules https://github.com/KhronosGroup/Vulkan-Hpp.git``` ```git clone --recurse-submodules https://github.com/KhronosGroup/Vulkan-Hpp.git```
2. Change the current directory to the newly created Vulkan-Hpp directory. 2. Change the current directory to the newly created Vulkan-Hpp directory.
3. Create a new folder named ```build``` and change the current directory to the newly created folder. 3. Create a build environment with CMake
4. Create a build environment with CMake ```cmake -D DSAMPLES_BUILD_WITH_LOCAL_VULKAN_HPP=ON -DSAMPLES_BUILD=ON -DTESTS_BUILD_WITH_LOCAL_VULKAN_HPP=ON -DTESTS_BUILD=ON -B build```
```cmake -D DSAMPLES_BUILD_WITH_LOCAL_VULKAN_HPP=ON -DSAMPLES_BUILD=ON -DTESTS_BUILD_WITH_LOCAL_VULKAN_HPP=ON -DTESTS_BUILD=ON -G "<generator>" ..``` You might have to specify a generator via `-G`, for a full list of generators execute ```cmake -G```.
For a full list of generators execute ```cmake -G```.
* To rebuild `vulkan.hpp` from the `vk.xml` XML registry file, add the * To rebuild `vulkan.hpp` from the `vk.xml` XML registry file, add the
`-DVULKAN_HPP_RUN_GENERATOR=ON` option to the CMake command line. `-DVULKAN_HPP_RUN_GENERATOR=ON` option to the CMake command line.
5. Either open the generated project with an IDE, e.g. Visual Studio or launch the build process with ```cmake --build .```. 4. Either open the generated project with an IDE, e.g. Visual Studio or launch the build process with ```cmake --build .```.
Optional: To update the Vulkan-Hpp and its submodules execute ```git pull --recurse-submodules```. Optional: To update the Vulkan-Hpp and its submodules execute ```git pull --recurse-submodules```.