summaryrefslogtreecommitdiff
path: root/gr-fcd/doc/fcd.dox
diff options
context:
space:
mode:
Diffstat (limited to 'gr-fcd/doc/fcd.dox')
-rw-r--r--gr-fcd/doc/fcd.dox29
1 files changed, 29 insertions, 0 deletions
diff --git a/gr-fcd/doc/fcd.dox b/gr-fcd/doc/fcd.dox
new file mode 100644
index 000000000..a4420f6b3
--- /dev/null
+++ b/gr-fcd/doc/fcd.dox
@@ -0,0 +1,29 @@
+/*! \page page_fcd FunCube Dongle Source
+
+\section Introduction
+
+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:
+
+\code
+ from gnuradio import fcd
+\endcode
+
+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:
+
+\code
+ help(fcd)
+\endcode
+
+\section Dependencies
+
+The FCD blocks require the following dependencies.
+
+\li libusb-1.0 (version >= 1.0)
+
+*/