aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJuergen Ryannel <juergen.bocklage-ryannel@pelagicore.com>2016-11-30 09:57:07 +0100
committerJuergen Ryannel <juergen.bocklage-ryannel@pelagicore.com>2016-11-30 10:01:20 +0100
commitf8cbc973e28926e203a7a0022ce1a59ee9e4b4d2 (patch)
tree5c982bf9eeed634d845d036396898c07229b86be /README.md
parente56a1768cf6b8c2b27e7d29cdd5a0bb726ff93a1 (diff)
updated license and descriptions
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 16 insertions, 12 deletions
diff --git a/README.md b/README.md
index 6b53e59..d4cd157 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,25 @@
-# QML Interface Builder
+# Qt Interface Builder (QFace)
-Infrastructure to build a QML/Qt CPP interface based on an interface definition
-language and templates.
-This tool set is not build for highest performance. Rather flexibility in the
-IDL design and generator creation was the goal. It uses great libraries to
-minimize the amount of code required to be maintained.
+QFace is an generator framework based on a common modern IDL. It is not a generator a such but enforces a common IDL format and provides a library to write your own generator. It is actually very easy to create your own generator and generate your custom solution based on your needs from the same IDL.
-The code parsing and generation part a very flexible and allows many users to
-generate their vision of a QMLCPP interface.
+The IDL is designed after the Qt/QML interface and as such is optimized to generate source code used with Qt C++ or Qt QML, but it is not limited to this use case.
-The Domain language is surely not limited to this.
+QFace is already very fast by design and suitable for large IDL document sets. Additionally it can use a cache to avoid parsing unchanged IDL documents. It can automatically avoid writing new files if the target file has the same content.
+
+QFace is written out of the learnings of using IDLs in other large projects. Often in the project you need to adjust the code generation but in many generators this is awfully complicated. Or you need to run a report on the documents or generate specific documentation. In QFace this is enabled by having a very flexible code generation framework which enforces the same IDL.
Please see the INSTALL and USAGE guides for more information.
-## Echo Example
+## Copyright and license
+
+Copyright (C) 2016 Pelagicore AG
+
+The source code in this repository is subject to the terms of the GPLv3 licence, please see included "LICENSE" file for details.
+
+
+## QFace Example
+
```js
// echo.qdl
@@ -39,5 +44,4 @@ 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.
+Depending on the used generator it reads the input file and runs it through the generator. The output files are written relative to the given output directory. The input can be either a file or a folder.