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