aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorEric Laurent <elaurent@google.com>2013-03-08 14:50:45 -0800
committerEric Laurent <elaurent@google.com>2013-04-17 14:29:34 -0700
commitc902d7fb4e0f2b086030f384ce217679775ca2d4 (patch)
tree9efe1720f9bfa6508c9e5a2f9cac3d3ad0cce684 /README
parent4904eeaecb97b8ab329d510126ede2777491e397 (diff)
downloadtinycompress-c902d7fb4e0f2b086030f384ce217679775ca2d4.tar.gz
Initial version of tinycompress
From git://git.alsa-project.org/tinycompress.git 0765f97a Change-Id: I34599092e8c764ecb3475883d1d46cd9c9b5c439
Diffstat (limited to 'README')
-rw-r--r--README30
1 files changed, 30 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..73c19a6
--- /dev/null
+++ b/README
@@ -0,0 +1,30 @@
+ README for tinycompress
+ =======================
+ vinod.koul@linux.intel.com
+ ==========================
+
+1. WHAT
+ tinycompress is a userspace library for anyone who wants to use the ALSA
+compressed APIs introduced in Linux 3.3
+This library provides the APIs to open a ALSA compressed device and read/write
+compressed data like MP3 etc to it.
+
+ This also includes a utility command line player (cplay) which demonstrates
+the usage of this API. Currently this contains support for playing the mp3 format
+
+2. WHERE
+ The library can found in alsa-project.org
+Git: git clone git://git.alsa-project.org/tinycompress.git
+Http: http://git.alsa-project.org/?p=tinycompress.git
+
+3. PATCHES
+ Please send any enhancements/fixes to alsa developer mailing list at:
+alsa-devel@alsa-project.org.
+
+4. LICENSE
+ tinycompress is provided under LGPL and BSD dual license
+
+5. CREDITS
+- Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com> for library design
+- Navjot Singh <navjot.singh@intel.com> for writing the mp3 parser code
+