summaryrefslogtreecommitdiff
path: root/gr-audio/doc/README.audio
diff options
context:
space:
mode:
Diffstat (limited to 'gr-audio/doc/README.audio')
-rw-r--r--gr-audio/doc/README.audio20
1 files changed, 20 insertions, 0 deletions
diff --git a/gr-audio/doc/README.audio b/gr-audio/doc/README.audio
new file mode 100644
index 000000000..ebd0fe5d7
--- /dev/null
+++ b/gr-audio/doc/README.audio
@@ -0,0 +1,20 @@
+This is the gr-audio package. This package includes all of the
+supported audio interfaces, including:
+ - alsa
+ - oss
+ - jack
+ - portaudio
+ - osx
+ - windows
+
+Typically, the audio package will auto-detect the proper driver to use
+based on the system it is run on. Import this package with:
+
+ from gnuradio import audio
+
+See the Doxygen documentation for details about the blocks available
+in this package. A quick listing of the details can be found in Python
+after importing by using:
+
+ help(audio)
+