summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README10
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.
© All Rights Reserved