summaryrefslogtreecommitdiff
path: root/gr-utils/python/modtool/gr-newmod/docs/README.howto
diff options
context:
space:
mode:
authorJohnathan Corgan <johnathan@corganlabs.com>2013-02-12 20:19:12 -0800
committerJohnathan Corgan <johnathan@corganlabs.com>2013-02-12 20:19:12 -0800
commit77fd6e43695798b1e243e69f01f727b867bebe91 (patch)
tree1b956d099bff28f2bab851118c4854792e03ff01 /gr-utils/python/modtool/gr-newmod/docs/README.howto
parent02a6d1cf7966079a857ab198d633aea9401b6f17 (diff)
parent6cfa483a0414683c7edca812cca19198d7c2f724 (diff)
Merge branch 'master' into next
Conflicts: gr-utils/python/create-gnuradio-out-of-tree-project
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)