summaryrefslogtreecommitdiff
path: root/gr-qtgui/doc/README.qtgui
diff options
context:
space:
mode:
Diffstat (limited to 'gr-qtgui/doc/README.qtgui')
-rw-r--r--gr-qtgui/doc/README.qtgui12
1 files changed, 12 insertions, 0 deletions
diff --git a/gr-qtgui/doc/README.qtgui b/gr-qtgui/doc/README.qtgui
new file mode 100644
index 000000000..e54c3d907
--- /dev/null
+++ b/gr-qtgui/doc/README.qtgui
@@ -0,0 +1,12 @@
+This is the gr-qtgui package. It contains various QT-based graphical
+user interface blocks that add graphical sinks to a GNU Radio
+flowgraph. The Python namespaces is in gnuradio.qtgui, which would be normally
+imported as:
+
+ from gnuradio import qtgui
+
+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(qtgui)