Files
VulkanDriver/README.md

33 lines
1.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Stroll Vulkan ICD <a href="https://github.com/Kbz-8/VulkanDriver/actions/workflows/Build.yml"><img src="https://github.com/Kbz-8/VulkanDriver/actions/workflows/Build.yml/badge.svg"></a> <a href="https://github.com/Kbz-8/VulkanDriver/actions/workflows/Test.yml"><img src="https://github.com/Kbz-8/VulkanDriver/actions/workflows/Test.yml/badge.svg"></a>
<img align="right" src="https://matthew.kerwin.net.au/blog_files/kappa"/>
A driver as slow as Lance Stroll.
Here lies the source code of a rather calamitous attempt at the Vulkan specification, shaped into an Installable Client Driver for a software-based renderer, all written in Zig.
It was forged for my own learning and amusement alone. Pray, do not wield it in any earnest project, lest thy hopes and frame rates both find themselves entombed.
## Purpose
To understand Vulkan — not as a humble API mere mortals call upon, but as a labyrinthine system where one may craft a driver by hand.
It does not seek to produce a performant or production-worthy driver. \
*The gods are merciful, but not that merciful.*
## Build
If thou art truly determined:
```
zig build
```
Then ensure thy Vulkan loader is pointed toward the ICD manifest.
The precise ritual varies by system — consult the tomes of your operating system, or wander the webs endless mausoleum of documentation.
Use at your own risk. If thy machine shudders, weeps, or attempts to flee — know that it was warned.
## License
Released unto the world as MIT for study, experimentation, and the occasional horrified whisper.
Do with it as thou wilt, but accept the consequences as thine own.