summaryrefslogtreecommitdiff
path: root/gr-fec/doc/README.fec
diff options
context:
space:
mode:
Diffstat (limited to 'gr-fec/doc/README.fec')
-rw-r--r--gr-fec/doc/README.fec12
1 files changed, 12 insertions, 0 deletions
diff --git a/gr-fec/doc/README.fec b/gr-fec/doc/README.fec
new file mode 100644
index 0000000000..02374bca84
--- /dev/null
+++ b/gr-fec/doc/README.fec
@@ -0,0 +1,12 @@
+This is the gr-fec package. It contains all of the FEC
+encoders and decoders. To use the FEC blocks, the Python
+namespace is in gnuradio.fec, which would be normally
+imported as:
+
+ from gnuradio import fec
+
+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(fec)