From c2fea6020a2d68bdb21537d3b88df803ab735bdf Mon Sep 17 00:00:00 2001 From: =?utf8?q?Alexis=20Laferri=C3=A8re?= Date: Sat, 29 Nov 2014 17:30:26 -0500 Subject: [PATCH] lib/sdl2: add README MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Alexis Laferrière --- lib/sdl2/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 lib/sdl2/README.md diff --git a/lib/sdl2/README.md b/lib/sdl2/README.md new file mode 100644 index 0000000..53bf506 --- /dev/null +++ b/lib/sdl2/README.md @@ -0,0 +1,13 @@ +This is a low-level wrapper of the SDL 2.0 library (as `sdl2`) and SDL_image 2.0 (as `sdl2::image`). + +The main entry point of this project, `sdl2`, exposes some features of the base +library: video, events, syswm, etc. The alternative entry point `sdl2::image` offers +mainly `SDLSurface::load` to load images from PNG, JPG or TIF files. + +You can also import `sdl2::all` to get `sdl2` and all its sister libraries, which is only +`sdl2::image` at this point. + +# Examples + +See the `minimal` example within this project at `examples/minimal` for a simple example +of how to use this project. -- 1.7.9.5