summaryrefslogtreecommitdiff
path: root/gr-fft/doc/README.fft
diff options
context:
space:
mode:
Diffstat (limited to 'gr-fft/doc/README.fft')
-rw-r--r--gr-fft/doc/README.fft13
1 files changed, 13 insertions, 0 deletions
diff --git a/gr-fft/doc/README.fft b/gr-fft/doc/README.fft
new file mode 100644
index 000000000..3ea9e81f8
--- /dev/null
+++ b/gr-fft/doc/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)