summaryrefslogtreecommitdiff
path: root/gr-vocoder/doc/README.vocoder
diff options
context:
space:
mode:
Diffstat (limited to 'gr-vocoder/doc/README.vocoder')
-rw-r--r--gr-vocoder/doc/README.vocoder12
1 files changed, 12 insertions, 0 deletions
diff --git a/gr-vocoder/doc/README.vocoder b/gr-vocoder/doc/README.vocoder
new file mode 100644
index 000000000..912d664ad
--- /dev/null
+++ b/gr-vocoder/doc/README.vocoder
@@ -0,0 +1,12 @@
+This is the gr-vocoder package. This package includes the various
+vocoder blocks in GNU Radio. To use the vocoder blocks, the Python
+namespaces is in gnuradio.vocoder, which would be normally imported
+as:
+
+ from gnuradio import vocoder
+
+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(vocoder)