aboutsummaryrefslogtreecommitdiffstats
path: root/src/gr-fadingui/docs/README.fadingui
diff options
context:
space:
mode:
Diffstat (limited to 'src/gr-fadingui/docs/README.fadingui')
-rw-r--r--src/gr-fadingui/docs/README.fadingui11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/gr-fadingui/docs/README.fadingui b/src/gr-fadingui/docs/README.fadingui
new file mode 100644
index 0000000..aeb8827
--- /dev/null
+++ b/src/gr-fadingui/docs/README.fadingui
@@ -0,0 +1,11 @@
+This is the fadingui-write-a-block package meant as a guide to building
+out-of-tree packages. To use the fadingui blocks, the Python namespaces
+is in 'fadingui', which is imported as:
+
+ import fadingui
+
+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(fadingui)