lib/sdl2/README.md

   1 This is a low-level wrapper of the SDL 2.0 library (as `sdl2`) and SDL_image 2.0 (as `sdl2::image`).
   2
   3 The main entry point of this project, `sdl2`, exposes some features of the base
   4 library: video, events, syswm, etc. The alternative entry point `sdl2::image` offers
   5 mainly `SDLSurface::load` to load images from PNG, JPG or TIF files.
   6
   7 You can also import `sdl2::all` to get `sdl2` and all its sister libraries, which is only
   8 `sdl2::image` at this point.
   9
  10 # Examples
  11
  12 See the `minimal` example within this project at `examples/minimal` for a simple example
  13 of how to use this project.