aboutsummaryrefslogtreecommitdiffstats
path: root/src/gr-fadingui/docs/README.fadingui
diff options
context:
space:
mode:
authorNao Pross <np@0hm.ch>2021-11-12 20:16:59 +0100
committerNao Pross <np@0hm.ch>2021-11-12 20:16:59 +0100
commit96123552f8c037d683aa669c7c47ad2ebc9b1955 (patch)
tree81384d5c71fc6f5968458f6164e0038905f1c85f /src/gr-fadingui/docs/README.fadingui
parentMerge remote-tracking branch 'origin/master' (diff)
downloadFading-96123552f8c037d683aa669c7c47ad2ebc9b1955.tar.gz
Fading-96123552f8c037d683aa669c7c47ad2ebc9b1955.zip
Create (a new) OOT
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)