summaryrefslogtreecommitdiff
path: root/gr-blocks/doc/README.blocks
diff options
context:
space:
mode:
Diffstat (limited to 'gr-blocks/doc/README.blocks')
-rw-r--r--gr-blocks/doc/README.blocks12
1 files changed, 12 insertions, 0 deletions
diff --git a/gr-blocks/doc/README.blocks b/gr-blocks/doc/README.blocks
new file mode 100644
index 000000000..418a06825
--- /dev/null
+++ b/gr-blocks/doc/README.blocks
@@ -0,0 +1,12 @@
+This is the gr-blocks package. It contains the basic blocks that are
+widely used in many different types of flowgraphs. To use these blocks,
+the Python namespace is in gnuradio.blocks, which would be normally
+imported as:
+
+ from gnuradio import blocks
+
+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(blocks)