implementation readme

This commit is contained in:
KikooDX 2022-03-12 18:30:32 +01:00
parent 44a2dbfc3d
commit 140bed1492
1 changed files with 34 additions and 0 deletions

34
README.md Normal file
View File

@ -0,0 +1,34 @@
# lzy
Simple game framework for SDL2 and gint.
## Usage
Drop (inc/lzy.h)[lzy.h] into an existing project.
Include implementation in a single source file:
```c
#define LZY_IMPLEMENTATION
#include "lzy.h"
```
Optional defines before implementation:
```c
#define LZY_IMPLEMENTATION
#define LZY_SDL_INCLUDE <SDL.h>
#define LZY_SDL_IMAGE_INCLUDE <SDL_image.h>
#define LZY_SDL_MIXER_INCLUDE <SDL_mixer.h>
#define LZY_GINT_TILESET bimg_tset
#define LZY_GINT_FONT bimg_font
#define LZY_DISPLAY_WIDTH 396
#define LZY_DISPLAY_HEIGHT 224
#define LZY_TILE_SIZE 16
#define LZY_CHR_WIDTH LZY_TILE_SIZE
#define LZY_CHR_HEIGHT LZY_TILE_SIZE
#define LZY_FIRST_CHR ' '
#include "lzy.h"
```
Don't define `LZY_IMPLEMENTATION` before other inclusions.
For data structures and function prototypes, read the source.