aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorjryannel <juergen@ryannel.org>2017-01-17 13:40:30 +0100
committerGitHub <noreply@github.com>2017-01-17 13:40:30 +0100
commit1d84c176838e737f85786246a2d1736496eaff83 (patch)
tree5af603b573d87cd3f54aba87028ff529d1d3b385 /README.md
parentff1398edcc0e9bbd07c57114b919b7c2ea04106d (diff)
Added install and download section
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index d7fc0e7..d0041d1 100644
--- a/README.md
+++ b/README.md
@@ -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