improving readme

This commit is contained in:
2025-11-06 08:30:28 +01:00
parent 72e24bf954
commit f943ea4273
6 changed files with 58 additions and 33 deletions

View File

@@ -1,9 +1,32 @@
# Stroll Vulkan Driver
# Stroll Vulkan ICD
<img align="right" src="https://matthew.kerwin.net.au/blog_files/kappa"/>
A driver as slow as Lance Stroll.
Here is the source code of a disastrous implementation of the Vulkan specification as an Installable Client Driver (ICD) in a software graphics driver written in Zig.
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 exists solely for my own educational purposes and should not be taken seriously or be used in any *real* project.
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.