aboutsummaryrefslogtreecommitdiffstats
path: root/gr-gmr1/docs/README.gmr1
diff options
context:
space:
mode:
Diffstat (limited to 'gr-gmr1/docs/README.gmr1')
-rw-r--r--gr-gmr1/docs/README.gmr19
1 files changed, 9 insertions, 0 deletions
diff --git a/gr-gmr1/docs/README.gmr1 b/gr-gmr1/docs/README.gmr1
new file mode 100644
index 0000000..79c0645
--- /dev/null
+++ b/gr-gmr1/docs/README.gmr1
@@ -0,0 +1,9 @@
+To use the gr-gmr1 blocks in Python, import it as :
+
+ from gnuradio import gmr1
+
+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(gmr1)