summaryrefslogtreecommitdiff
path: root/gr-utils/src/python/modtool/gr-newmod/docs/README.howto
diff options
context:
space:
mode:
Diffstat (limited to 'gr-utils/src/python/modtool/gr-newmod/docs/README.howto')
-rw-r--r--gr-utils/src/python/modtool/gr-newmod/docs/README.howto11
1 files changed, 11 insertions, 0 deletions
diff --git a/gr-utils/src/python/modtool/gr-newmod/docs/README.howto b/gr-utils/src/python/modtool/gr-newmod/docs/README.howto
new file mode 100644
index 000000000..a0a6c0f19
--- /dev/null
+++ b/gr-utils/src/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)