diff --git a/README.md b/README.md index 1427fd6..2877f4e 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,12 @@ this will likely see breaking changes. ### 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. + - Only an SDL2 `platform` implementation [is done](https://github.com/NoelFB/blah/blob/master/private/blah/internal/platform_sdl2.cpp). CMake will need to find your own installation of SDL2 through `SDL2_INCLUDE_DIRS` and `SDL2_LIBRARIES` + - Only an OpenGL `graphics` implementation [is done](https://github.com/NoelFB/blah/blob/master/private/blah/internal/graphics_opengl.cpp), 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 +### Notes - 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. + - I use my own "vector" class which is called List and Stacklist. this may later be replaced with std::vector + - There's no Shader code abstraction, so the current Sprite Batcher has a hard-coded OpenGL shader. At some point this will need to change. + - I may replace the rendering layer entirely with [FNA3D](https://github.com/FNA-XNA/FNA3D), [BGFX](https://github.com/bkaradzic/bgfx), [Sokol](https://github.com/floooh/sokol), or something else. + - There's no Audio layer implementation yet.