summaryrefslogtreecommitdiff
path: root/gr-digital/doc/README.digital
diff options
context:
space:
mode:
Diffstat (limited to 'gr-digital/doc/README.digital')
-rw-r--r--gr-digital/doc/README.digital13
1 files changed, 13 insertions, 0 deletions
diff --git a/gr-digital/doc/README.digital b/gr-digital/doc/README.digital
new file mode 100644
index 000000000..f4d40f3a0
--- /dev/null
+++ b/gr-digital/doc/README.digital
@@ -0,0 +1,13 @@
+This is the gr-digital package. It contains all of the digital
+modulation blocks, utilities, and examples. To use the digital blocks,
+the Python namespaces is in gnuradio.digital, which would be normally
+imported as:
+
+ from gnuradio import digital
+
+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(digital)
+