From dc6858d19308fe8a23f0930aababda886674af73 Mon Sep 17 00:00:00 2001 From: Stefan <29021710+Saalvage@users.noreply.github.com> Date: Fri, 12 Nov 2021 03:08:52 +0100 Subject: [PATCH] Slightly simplified setup instructions 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. --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 41c562a..33aaaac 100644 --- a/README.md +++ b/README.md @@ -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: ```git clone --recurse-submodules https://github.com/KhronosGroup/Vulkan-Hpp.git``` 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. -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 -G "" ..``` - For a full list of generators execute ```cmake -G```. +3. 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``` + You might have to specify a generator via `-G`, for a full list of generators execute ```cmake -G```. * To rebuild `vulkan.hpp` from the `vk.xml` XML registry file, add the `-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```.