Learn Vulkan

This repository hosts the learn-vulkan guide's C++ source code. It also hosts the sources of the guide itself.

Building

Requirements

• CMake 3.24+
• C++23 compiler and standard library
• [Linux] GLFW dependencies for X11 and Wayland

Steps

Standard CMake workflow. Using presets is recommended, in-source builds are not recommended. See the CI script for building on the command line.

Branches

1. main^: latest, stable code (builds and runs), stable history (never rewritten)
2. production^: guide deployment (live), stable code and history
3. section/*^: reflection of source at the end of corresponding section in the guide, stable code
4. feature/*: potential upcoming feature, shared contributions, stable history
5. others: unstable

^ rejects direct pushes (PR required)

Original Repository