diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 17 insertions, 1 deletions
@@ -3,7 +3,7 @@ [](https://travis-ci.org/Pelagicore/qface) [](http://qface.readthedocs.io/en/latest/?badge=latest) -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. +QFace is a generator framework based on a common modern IDL. It is not a generator as 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 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. @@ -13,6 +13,22 @@ QFace is written out of the learnings of using IDLs in other large projects. Oft Please see the INSTALL and USAGE guides for more information. +## Install + +To install the qface library you need to have python3 and pip installed. + +```sh +pip3 install qface +``` + +## Download + +If you are looking for the examples and the builtin generators you need to download the code. + +```sh +git clone git@github.com:Pelagicore/qface.git +``` + ## Copyright and license Copyright (C) 2016 Pelagicore AG |