summaryrefslogtreecommitdiff
path: root/gr-utils/python/modtool/gr-newmod/docs/README.howto
diff options
context:
space:
mode:
authorTom Rondeau <trondeau@vt.edu>2013-02-13 13:34:58 -0500
committerTom Rondeau <trondeau@vt.edu>2013-02-13 13:34:58 -0500
commitda8abe401ae3859b07c48fb2a5dab4717b6c15cc (patch)
tree357eef8306745eabbb7a41b8d81ffe8db7ff7e6e /gr-utils/python/modtool/gr-newmod/docs/README.howto
parenta482bd9a29ba643ff148ae392dc359ff53dd7fb9 (diff)
parentaf7d55fda43746ae187bc520952eacf420f8363f (diff)
Merge branch 'next' of gnuradio.org:gnuradio into next
Diffstat (limited to 'gr-utils/python/modtool/gr-newmod/docs/README.howto')
-rw-r--r--gr-utils/python/modtool/gr-newmod/docs/README.howto11
1 files changed, 11 insertions, 0 deletions
diff --git a/gr-utils/python/modtool/gr-newmod/docs/README.howto b/gr-utils/python/modtool/gr-newmod/docs/README.howto
new file mode 100644
index 0000000000..a0a6c0f19d
--- /dev/null
+++ b/gr-utils/python/modtool/gr-newmod/docs/README.howto
@@ -0,0 +1,11 @@
+This is the howto-write-a-block package meant as a guide to building
+out-of-tree packages. To use the howto blocks, the Python namespaces
+is in 'howto', which is imported as:
+
+ import howto
+
+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(howto)