summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJuergen Bocklage-Ryannel <juergen.bocklage-ryannel@pelagicore.com>2016-09-16 08:43:00 +0200
committerJuergen Ryannel <juergen.bocklage-ryannel@pelagicore.com>2016-11-30 10:01:20 +0100
commite147445c2b1a11d5d5138e297beb2a9b6a3e71e4 (patch)
tree413f8c184023d45522b06d61926adde97326cfeb /README.md
parent4227e1f940d233d305140b868476c5ae4a5bf67b (diff)
downloadqtivi-qface-e147445c2b1a11d5d5138e297beb2a9b6a3e71e4.tar.gz
Updated to documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
index 932dc4a..6b53e59 100644
--- a/README.md
+++ b/README.md
@@ -13,3 +13,31 @@ generate their vision of a QMLCPP interface.
The Domain language is surely not limited to this.
Please see the INSTALL and USAGE guides for more information.
+
+## Echo Example
+
+```js
+// echo.qdl
+module org.example 1.0;
+
+/**!
+The echo interface to call someone
+on the other side
+*/
+interface Echo {
+ readonly Message lastMessage;
+ void echo(Message message);
+ event void callMe();
+};
+
+struct Message {
+ string text;
+};
+```
+
+Now calling the generator to generate the C++ code.
+
+ qface --generator qtcpp --input echo.qdl --output out
+
+It generates a .PRI file and all code required to regsiter the objects to the qml engine.
+The generated code expects the user implements a generated interface.