/vulkan-notes

My notes on how Vulkan works

Primary LanguageCSSOtherNOASSERTION

Vulkan notes

These are my notes on how Vulkan works (see vulkan_notes.md). They're written kind of like a long article and I might tighten them up into a proper tutorial or something eventually. Mostly they are distilled from the Vulkan spec itself. The information I've gathered here is more-or-less focused on what would be relevant for someone making a 3D game engine, because that's what I'm doing over at the Crypt Underworld repo.

The notes are written in Markdown. There is a little Bash script start here you can use that will watch the Markdown file for changes and convert it to HTML and concatenate it with a header and footer when it notices any. It will also open the finished web page in Firefox, and launch gVim to edit the notes with. This is obviously kind of specific to my environment but it might be useful to you too if you have the various programs installed (in addition to Firefox and gVim you should have the markdown CLI, inotify-wait from inotify-tools, and Ruby available on your PATH—check your distro's packages). start depends on the script do_on_save which I have in my personal bindir but I have included here for your convenience.

The notes themselves (vulkan_notes.md) are made available under the CC BY-SA 4.0 license, and the scripts (start and do_on-save) are made available under the GPL-3+. See COPYING.md for details. There are a few things here made by other people and the licenses and authorship information for those things accompany them in the same directory where applicable.