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