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