From 3c8e214f6d4987c3ca9b58f7b6aa88b45b37bffa Mon Sep 17 00:00:00 2001 From: Benedikt Ziemons Date: Tue, 18 Jan 2022 23:41:21 +0100 Subject: [PATCH] Update README.md --- .gitignore | 1 + README.md | 16 +++++++++++++++- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 5ca3806..af5014f 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ +/build /cmake-build-* diff --git a/README.md b/README.md index 8baf93b..1c2c491 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,20 @@ and and . Needs cmake 3.21+, C++20 compiler, Qt 5.10+ +```shell +cmake -B build +sh -c 'cd build && make' +``` + ## Usage -ESC to quit +Run in your terminal: +```shell +build/VulkanCppSetup +``` + +Note: Program needs to be run from the project directory +(parent directory of `shaders`), because the shader files are +loaded based on the working directory. + +ESC (or any `QKeySequence::Quit`) to quit