summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVito Caputo <vcaputo@pengaru.com>2017-05-27 00:13:36 -0700
committerVito Caputo <vcaputo@pengaru.com>2017-05-27 00:13:36 -0700
commit10338bf9283a86471aaf1a4702e8f02e6c9c4f52 (patch)
tree4ca1cee09510df64c9cc54f62dc59d392f8ee98d
parent098f704d2134e446fa6b27ce902c5fc2646d3ab4 (diff)
doc: add basic README
-rw-r--r--README12
1 files changed, 12 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..11e26ae
--- /dev/null
+++ b/README
@@ -0,0 +1,12 @@
+libplayit is an IT playback-only fork of the Schism tracker[1] player
+engine for demo use.
+
+Schism tracker originally was built on libmodplug for playback. Over time
+playback quality and correctness issues were fixed without percolating
+upstream. Additionally, eventually all of the modplug C++ source was
+converted to plain C code.
+
+See the code in examples/* for how one might use this library to play .it
+files.
+
+[1]: https://github.com/schismtracker/schismtracker
© All Rights Reserved