summaryrefslogtreecommitdiff
path: root/gr-fft/docs/README.fft
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2018-02-03 16:58:15 +0100
committerMartin Braun <martin.braun@ettus.com>2018-02-03 16:58:43 +0100
commitdb7e26bc73fd71bc88249131f57f7edef308fa63 (patch)
treed084ad2615012d53c50a230821761349eb978d56 /gr-fft/docs/README.fft
parent3c63f7334d6de70d655aa97fcccbfb950645f4d4 (diff)
parenta35e10870bbb9a71b3ab66b1dc58135e08c9543e (diff)
Merge branch 'master' into next
Diffstat (limited to 'gr-fft/docs/README.fft')
-rw-r--r--gr-fft/docs/README.fft13
1 files changed, 13 insertions, 0 deletions
diff --git a/gr-fft/docs/README.fft b/gr-fft/docs/README.fft
new file mode 100644
index 0000000000..3ea9e81f8b
--- /dev/null
+++ b/gr-fft/docs/README.fft
@@ -0,0 +1,13 @@
+This is the gr-fft package. It contains signal processing blocks to
+perform FFTs and FFT-related functionality.
+
+The Python namespace is in gnuradio.fft, which would be normally
+imported as:
+
+ from gnuradio import fft
+
+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(fft)