From 5240970e1cd815a5b8fc8e8651e447408efb668e Mon Sep 17 00:00:00 2001 From: homeburger Date: Wed, 6 May 2026 18:32:45 -0500 Subject: [PATCH] add readme --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e6fa26c --- /dev/null +++ b/README.md @@ -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 + +