implementation readme

1 files changed, 34 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9c245c4
--- /dev/null
+++ b/README.md
@@ -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.