summaryrefslogtreecommitdiff
path: root/gr-fcd/doc/README.fcd
diff options
context:
space:
mode:
Diffstat (limited to 'gr-fcd/doc/README.fcd')
-rw-r--r--gr-fcd/doc/README.fcd13
1 files changed, 13 insertions, 0 deletions
diff --git a/gr-fcd/doc/README.fcd b/gr-fcd/doc/README.fcd
new file mode 100644
index 000000000..6fff012b8
--- /dev/null
+++ b/gr-fcd/doc/README.fcd
@@ -0,0 +1,13 @@
+This is the gr-fcd package. It contains a source block for the
+FunCube Dongle hardware.
+
+The Python namespace is in gnuradio.qtgui, which would be normally
+imported as:
+
+ from gnuradio import fcd
+
+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(fcd)