aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkdx <kikoodx@paranoici.org>2023-01-15 02:27:52 +0100
committerkdx <kikoodx@paranoici.org>2023-01-16 19:56:48 +0100
commit98c438b3cf8cda9924c6393d816534c82372f95b (patch)
tree5945a22ddb92764ec3d8ac98fc6a783dc8deaad7
parent45e71052a2ac340fc687b4ab9d7e60190ff8e63b (diff)
downloadlzr-98c438b3cf8cda9924c6393d816534c82372f95b.tar.gz
update README
-rw-r--r--README.md18
1 files changed, 11 insertions, 7 deletions
diff --git a/README.md b/README.md
index bb020aa..9d549b2 100644
--- a/README.md
+++ b/README.md
@@ -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.