add readme

This commit is contained in:
2026-05-06 18:32:45 -05:00
commit 5240970e1c

19
README.md Normal file
View File

@@ -0,0 +1,19 @@
# Maiden
The maiden project is a GPU accelerated 3D rendering engine built with C++ based on the Vulkan API for an emphasis on optimization and performance. The engine is intended to:
- be usable cross platform
- use minimal external libraries
- be configurable
- be performance profilable
## Getting Started
### git instructions here
### build instructions here
### app troubleshooting here
### testing instructions here
## Development Roadmap
### lots of todo here