summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorMichal Ratajsky <[email protected]>2014-09-09 00:51:33 +0200
committerMichal Ratajsky <[email protected]>2014-09-09 00:51:33 +0200
commit0ab66491e3847f6de92fc5358e9687c6d2f458ce (patch)
treeef4618211957b14e61cb8f250baba0c4d53c90d5 /README
parente9b479383e1ba9736502dc6859cad383a791a0c3 (diff)
downloadlibmatemixer-0ab66491e3847f6de92fc5358e9687c6d2f458ce.tar.bz2
libmatemixer-0ab66491e3847f6de92fc5358e9687c6d2f458ce.tar.xz
Add README file content
Diffstat (limited to 'README')
-rw-r--r--README36
1 files changed, 36 insertions, 0 deletions
diff --git a/README b/README
index e69de29..f7631b1 100644
--- a/README
+++ b/README
@@ -0,0 +1,36 @@
+libmatemixer
+============
+
+libmatemixer is a mixer library for MATE desktop.
+
+It provides an abstract API allowing access to mixer functionality available
+in the PulseAudio, ALSA and OSS sound systems.
+
+Documentation for the API is provided with gtk-doc.
+
+Installation and packaging
+==========================
+
+See the INSTALL file for general instructions about the build process.
+
+The library includes dynamically loaded modules which provide access to each
+of the supported sound systems.
+
+By default configure auto-detects whether support for PulseAudio and ALSA
+is available in the system. Make sure to install the appropriate development
+packages to allow the modules to be built.
+
+Building the OSS module is only advised on non-Linux systems as OSS support
+in Linux is only provided as an ALSA emulation layer. To build the OSS module,
+you will need to pass --enable-oss=yes to configure.
+
+As the modules are loaded dynamically each time an application utilizes the
+library, it is possible to provide the modules in separate distribution
+packages.
+
+How to report bugs
+==================
+
+Bugs should be reported to the MATE bug tracking system on GitHub:
+
+ https://github.com/mate-desktop/libmatemixer/issues/