Skip to content

Commit

Permalink
README.md: Installation instruction of using qpm
Browse files Browse the repository at this point in the history
  • Loading branch information
benlau committed Nov 17, 2015
1 parent baeae00 commit f5c6909
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,40 @@ Feature List
1. Q.setTimeout() - An implementation of setTimeout() function for QML.
2. all()/allSettled() - Create a promise object from an array of promises

Installation Instruction (qpm)
==============================

1) Run `qpm install`

```
$ qpm install com.github.benlau.quickpromise
```

2) Include vendor/vendor.pri in your .pro file

You may skip this step if you are already using qpm.

```
include(vendor/vendor.pri)
```

3) Add "qrc://" to your QML import path

```
engine.addImportPath("qrc:///"); // QQmlEngine
```

4) Add import statement in your QML file

```
import QuickPromise 1.0
```

Installation Instruction
========================

1) Clone this repository or download release to a folder within your source tree.

(You may use `git submodule` to embed this repository)

2) Add this line to your profile file(.pro):

include(quickpromise/quickpromise.pri) # You should modify the path by yourself
Expand Down

0 comments on commit f5c6909

Please sign in to comment.