summaryrefslogtreecommitdiff
path: root/gr-fcd/doc
diff options
context:
space:
mode:
Diffstat (limited to 'gr-fcd/doc')
-rw-r--r--gr-fcd/doc/.gitignore2
-rw-r--r--gr-fcd/doc/CMakeLists.txt23
-rw-r--r--gr-fcd/doc/Makefile.am29
-rw-r--r--gr-fcd/doc/README.fcd13
-rw-r--r--gr-fcd/doc/fcd.dox29
5 files changed, 96 insertions, 0 deletions
diff --git a/gr-fcd/doc/.gitignore b/gr-fcd/doc/.gitignore
new file mode 100644
index 000000000..b336cc7ce
--- /dev/null
+++ b/gr-fcd/doc/.gitignore
@@ -0,0 +1,2 @@
+/Makefile
+/Makefile.in
diff --git a/gr-fcd/doc/CMakeLists.txt b/gr-fcd/doc/CMakeLists.txt
new file mode 100644
index 000000000..d080b384e
--- /dev/null
+++ b/gr-fcd/doc/CMakeLists.txt
@@ -0,0 +1,23 @@
+# Copyright 2012 Free Software Foundation, Inc.
+#
+# This file is part of GNU Radio
+#
+# GNU Radio is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3, or (at your option)
+# any later version.
+#
+# GNU Radio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with GNU Radio; see the file COPYING. If not, write to
+# the Free Software Foundation, Inc., 51 Franklin Street,
+# Boston, MA 02110-1301, USA.
+
+install(
+ FILES README.fcd
+ DESTINATION ${GR_PKG_DOC_DIR}
+)
diff --git a/gr-fcd/doc/Makefile.am b/gr-fcd/doc/Makefile.am
new file mode 100644
index 000000000..f3cf30ac3
--- /dev/null
+++ b/gr-fcd/doc/Makefile.am
@@ -0,0 +1,29 @@
+#
+# Copyright 2012 Free Software Foundation, Inc.
+#
+# This file is part of GNU Radio
+#
+# GNU Radio is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3, or (at your option)
+# any later version.
+#
+# GNU Radio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with GNU Radio; see the file COPYING. If not, write to
+# the Free Software Foundation, Inc., 51 Franklin Street,
+# Boston, MA 02110-1301, USA.
+#
+
+include $(top_srcdir)/Makefile.common
+
+SUBDIRS =
+
+dist_gr_doc_DATA = \
+ README.fcd
+
+EXTRA_DIST = fcd.dox \ No newline at end of file
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)
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)
+
+*/