diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 11 insertions, 7 deletions
@@ -1,17 +1,21 @@ # LZR -Simple C game framework based on SDL2. -LZR is meant to be used in my own games as a base, -while staying simple, flexible and easy to grasp at the core. +Simple C/C++ game framework based on SDL2. +LZR is used in [my own games](https://kdx.re/games) as a base. +It should stay simple, flexible and easy to grasp at the core. ## dependencies -LZR depends on SDL2, SDL2_gfx, SDL_image, SDL_mixer and -[libdx](https://git.sr.ht/~kikoodx/libdx). +LZR depends on [SDL2](https://libsdl.org), +and has opt-out dependencies on +[SDL2_gfx](https://www.ferzkopp.net/wordpress/2016/01/02/sdl_gfx-sdl2_gfx/), +[SDL_image 2.0](https://github.com/libsdl-org/SDL_image), and +cmixer. ## usage -Drop lzr.c and lzr.h in a project, add flags for the dependencies. +Drop lzr.c and lzr.h in a project, add flags for the dependencies +(see this project's Makefile for sane defaults). Initialize LZR with `LZR_Init()`, quit and cleanup with `LZR_Quit()`. Header is self documented, see `lzr.h`. ## license -LZR is under the MIT license, see LICENSE for details. +LZR is under the MIT license, see [LICENSE](LICENSE) for details. |