Alexandre_1a/Vulkan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

yapped on the readme

Browse Source
This commit is contained in:
Alexandre 2026-10-01 00:18:54 +02:00
parent 2f06209391
commit 7e4aa7930c
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -5,3 +5,20 @@ Might expending it later into a game or engine.
Based from [vkguide](https://vkguide.dev/)
This has a very different philosophy than the main [Khronos Vulkan Tutorial](https://docs.vulkan.org/tutorial/latest/00_Introduction.html)
## Install
You can build it yourself, using two methods:
1- Use a devenv, and cmake
2- Use nix build
Or you can grab an artefact from the actions tab (currently broken).
## Usage
All runtime documentation is included in the program, just launch it witout any arguments, or with the `-h` flag to see how to use it.
## Known bugs
Currently, when opening a new build, the imgui layout is not done, you need to dock everything yourself, only at the first launch (after that, the layout is saved in `imgui.ini`)
You also need to launch the executable in the same folder as the assets (shaders, models, textures).
All of these "bugs" are planned to be fixed.