From b84bb9885d3da6ebdcd4ce4f1ff8e44b5ca7e260 Mon Sep 17 00:00:00 2001 From: Noel Berry Date: Thu, 27 Aug 2020 18:06:48 -0700 Subject: [PATCH] Update README.md --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b5d7b92..1427fd6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,12 @@ ## blah +a small C++ game framework for 2D games. +this will likely see breaking changes. -this is my c++ game framework thing for making games in. - -this will likely see frequent breaking changes as i mess with it. \ No newline at end of file +### Prerequisites + - A C++17 compiler and CMake + - Only an SDL2 "platform" implementation is done. CMake will need to find your own installation of SDL2 through `SDL2_INCLUDE_DIRS` and `SDL2_LIBRARIES` + - Only an OpenGL "graphics" implementation is done, so it currently requires OpenGL. + +### Other Notes + - I use my own "vector" class which is called List and Stacklist. I may later replace with with std::vector + - There are probably lots of small bugs as I've only tested this for my personal projects. This is probably best used as a learning resource for now.