summaryrefslogtreecommitdiff
path: root/examples/qml/shared/README
diff options
context:
space:
mode:
Diffstat (limited to 'examples/qml/shared/README')
-rw-r--r--examples/qml/shared/README11
1 files changed, 11 insertions, 0 deletions
diff --git a/examples/qml/shared/README b/examples/qml/shared/README
new file mode 100644
index 0000000000..bf16f238c7
--- /dev/null
+++ b/examples/qml/shared/README
@@ -0,0 +1,11 @@
+These files are shared between multiple examples as a set of common and
+reusuable components. While they do demonstrate the building of reusable
+components in QML, they are not official examples themselves.
+Consequently they do not have entries in the Qt documentation, and are
+documented only through the code comments within the files. Developers
+new to QML are strongly encouraged to go through the official examples
+before delving into this directory.
+
+For most application use, see the Qt Quick Components project to find
+ready-made Components you can use in your own projects. Qt Declarative
+examples do not use them only to avoid external dependencies.