summaryrefslogtreecommitdiff
path: root/libraries/libvorbisidec/README
diff options
context:
space:
mode:
Diffstat (limited to 'libraries/libvorbisidec/README')
-rw-r--r--libraries/libvorbisidec/README7
1 files changed, 7 insertions, 0 deletions
diff --git a/libraries/libvorbisidec/README b/libraries/libvorbisidec/README
new file mode 100644
index 0000000000..6309a26307
--- /dev/null
+++ b/libraries/libvorbisidec/README
@@ -0,0 +1,7 @@
+The Tremor Vorbis I stream and file decoder provides an embeddable, integer-only library [libvorbisidec] intended
+for decoding all current and future Vorbis I compliant streams. The Tremor libvorbisidec library exposes an API intended
+to be as similar as possible to the familiar 'vorbisfile' library included with the open source Vorbis reference
+libraries distributed for free by Xiph.org.
+
+Tremor can be used along with any ANSI compliant stdio implementation for file/stream access, or use custom stream i/o
+routines provided by the embedded environment. Both uses are described in detail in documentation.