*: initial commit

This is largely ripped out of Eon to try give a reusable
scaffolding for accelerating SDL-based simple game development.

I expect there to be future commits adding more configurability
like a means of influencing which flags are passed to SDL_Init(),
e.g. if you have no need for joystick support, don't pass in that
flag, and libplay won't pass it to SDL_Init() and do the joystick
opening/mapping dance, etc.

1 files changed, 10 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..d4c5571
--- /dev/null
+++ b/README
@@ -0,0 +1,10 @@
+libplay is thin veneer over SDL2 and SDL2_Mixer targeting simple game
+development.
+
+It gives a simple API for music playback with asynchronous next song
+queueing, rudimentary game context switching with event routing, and some
+basic timers built around SDL_Ticks.
+
+Note that this library doesn't do graceful error handling, since it
+targets game development errors are treated as fatal and simply exit
+with something printed to stderr.