summaryrefslogtreecommitdiff
path: root/gr-scigen/doc/README.scigen
diff options
context:
space:
mode:
Diffstat (limited to 'gr-scigen/doc/README.scigen')
-rw-r--r--gr-scigen/doc/README.scigen13
1 files changed, 13 insertions, 0 deletions
diff --git a/gr-scigen/doc/README.scigen b/gr-scigen/doc/README.scigen
new file mode 100644
index 000000000..61e8f6bf8
--- /dev/null
+++ b/gr-scigen/doc/README.scigen
@@ -0,0 +1,13 @@
+This is the gr-scigen package. It contains signal processing blocks to
+perform FFTs and FFT-related functionality.
+
+The Python namespace is in gnuradio.scigen, which would be normally
+imported as:
+
+ from gnuradio import scigen
+
+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(scigen)