summaryrefslogtreecommitdiff
path: root/gr-channels/doc/README.channels
diff options
context:
space:
mode:
Diffstat (limited to 'gr-channels/doc/README.channels')
-rw-r--r--gr-channels/doc/README.channels13
1 files changed, 13 insertions, 0 deletions
diff --git a/gr-channels/doc/README.channels b/gr-channels/doc/README.channels
new file mode 100644
index 0000000000..2488266a0b
--- /dev/null
+++ b/gr-channels/doc/README.channels
@@ -0,0 +1,13 @@
+This is the gr-channels package. It contains signal processing blocks to
+simulate channel models.
+
+The Python namespace is in gnuradio.channels, which would be normally
+imported as:
+
+ from gnuradio import channels
+
+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(channels)