From 34c8a8e591ec0dabe6e9bab0d65d3eae27ebb2db Mon Sep 17 00:00:00 2001
From: Tom Rondeau
Date: Sun, 9 Oct 2011 16:55:33 -0400
Subject: docs: This adds documentation to gr-digital in the form of a
 README.digital and a digital modulation page for the Doxygen manual. The
 manual's main page has been updated to link to the new digital modulation
 page.

---
 gr-digital/doc/README.digital | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 gr-digital/doc/README.digital

(limited to 'gr-digital/doc/README.digital')

diff --git a/gr-digital/doc/README.digital b/gr-digital/doc/README.digital
new file mode 100644
index 000000000..f4d40f3a0
--- /dev/null
+++ b/gr-digital/doc/README.digital
@@ -0,0 +1,13 @@
+This is the gr-digital package. It contains all of the digital
+modulation blocks, utilities, and examples. To use the digital blocks,
+the Python namespaces is in gnuradio.digital, which would be normally
+imported as:
+
+    from gnuradio import digital
+
+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(digital)
+
-- 
cgit