summaryrefslogtreecommitdiffstats
path: root/src/imports/threed/README.library_xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/imports/threed/README.library_xml')
-rw-r--r--src/imports/threed/README.library_xml13
1 files changed, 13 insertions, 0 deletions
diff --git a/src/imports/threed/README.library_xml b/src/imports/threed/README.library_xml
new file mode 100644
index 000000000..b253f4b19
--- /dev/null
+++ b/src/imports/threed/README.library_xml
@@ -0,0 +1,13 @@
+The library.xml file is required to get syntax highlighting of Qt3D
+plugin items. It is install into the imports/Qt3D tree along with
+the plugin and the qmldir file.
+
+When any of the elements - property names, class names or other exports
+- in the Qt3D plugin are changed this file will need to be regenerated.
+
+To generate the library.xml file see the scripts/README file for a
+description of how to use the filter-qmldump.pl script.
+
+This is a less-than-optimal solution but as syntax discovery improves
+in Qt Creator better solutions should become available at which time
+this temporary script and syntax file may be deprecated.