mossfet
/
efemra
forked from vv/efemra
1
0
Fork 0
Code Pull Requests Activity

deps and install info

This commit is contained in:
Vivianne 2022-07-18 20:09:54 -07:00
parent d8bb58af1b
commit 63aff9b1bc
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -5,3 +5,22 @@
Efemra is absolutely WIP and does not work at all! Feel free to watch as I stumble my way through Zig, Vulkan and graphics programming. I hope to have more to show for myself soon.
In the meantime, please check out pim, because that engine actually works and is super cool!
## dependencies
Currently I am only targeting Linux and testing on Gentoo. Probably will investigate Windows once things get further. You'll need:
* Zig 0.10 (this is the prerelease version)
* vulkan: headers, layers, and loader (these will depend on your package manager).
* glfw 3 headers
* Possibly some other stuff that you likely already have? TODO: experiment with building on a popular distro to see what's needed.
* Currently efemra isn't at the point of loading Quake levels, but that probably will eventually be a thing.
## building
It might not build yet... but in theory:
* Install [gyro](https://github.com/mattnite/gyro) zig package manager.
* Execute `gyro fetch` to fetch dependencies.
* Execute `gyro build run` to build and (someday) run!