summaryrefslogtreecommitdiffstats
path: root/audio/cubeb/README
diff options
context:
space:
mode:
Diffstat (limited to 'audio/cubeb/README')
-rw-r--r--audio/cubeb/README11
1 files changed, 11 insertions, 0 deletions
diff --git a/audio/cubeb/README b/audio/cubeb/README
new file mode 100644
index 0000000000..7848ab1ecf
--- /dev/null
+++ b/audio/cubeb/README
@@ -0,0 +1,11 @@
+cubeb is a cross platform audio library
+
+This script defaults to building against alsa and pulse.
+To disable alsa support, pass ALSA=false to the build script.
+To disable pulse support, pass PULSE=false to the build script.
+
+jack is an optional dependency and support can be enabled by passing
+JACK=true to the build script.
+
+Tests are enabled by default, to disable testing, pass TESTS=false
+to the build script.