overv/vulkantutorial

This repository contains the written content behind vulkan-tutorial.com, a free tutorial that teaches the Vulkan API. Vulkan is a low-level interface for programming graphics and computation on modern GPUs, used in games and other applications that need direct, high-performance control over the hardware. The tutorial walks through the process of getting images drawn on screen using Vulkan, step by step, with C++ code examples throughout. The text is written in Markdown files, and the website is generated from those files using a PHP-based documentation tool called daux.io. Readers who want to view or work with the tutorial locally need to set up PHP, install a dependency manager, and rebuild the documentation tool with a custom patch before they can see the rendered pages in a browser. There is also an option to generate a folder of plain HTML files instead of running a live server. The tutorial is available as an e-book in both EPUB and PDF formats, in English and French, downloadable from the website. Building these e-book versions locally requires additional tools: Inkscape for converting images and Pandoc for assembling the final document. PDF output also requires a LaTeX installation. For people who want to contribute or fix errors, the repository uses a patch-based workflow to keep code examples consistent across chapters. When a shared code snippet changes, a patch file is created and applied to all the chapters that follow, so nothing gets out of sync. The written content is licensed under Creative Commons Attribution-ShareAlike 4.0, meaning anyone can share and adapt it with credit. The code examples are placed in the public domain, so they can be used freely in any project without attribution.