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