aboutsummaryrefslogtreecommitdiff
path: root/examples/README
diff options
context:
space:
mode:
Diffstat (limited to 'examples/README')
-rw-r--r--examples/README11
1 files changed, 11 insertions, 0 deletions
diff --git a/examples/README b/examples/README
new file mode 100644
index 0000000..c2516e3
--- /dev/null
+++ b/examples/README
@@ -0,0 +1,11 @@
+This directory contains examples that demonstrate how to use the QMenuModel
+QML binding in applications.
+
+To export an example menu model on the bus, run 'exportmenu.py'.
+
+To render this menu in a QML application, run 'render-menumodel.qml' in
+qmlviewer. You will need to inform qmlviewer of the location of the QMenuModel
+if it’s not installed system-wide, e.g.:
+
+ qmlviewer -I libqmenumodel examples/render-menumodel.qml
+