mirror of
https://github.com/simonbrunel/qtpromise.git
synced 2024-11-22 10:40:08 +08:00
7f9013a878
- Add a root CMakeLists.txt defining an INTERFACE target. - Add CMake, qpm, Git and download installation instructions. - Add CMake and qmake integration instructions. - Remove smooth scroll when navigating the docs. - Add links validation to `npm run docs:link`. - Reorganize the sidebar API Reference section.
31 lines
1.5 KiB
Markdown
31 lines
1.5 KiB
Markdown
---
|
|
home: true
|
|
heroImage: /hero.svg
|
|
footer: MIT Licensed | Copyright © 2019 Simon Brunel
|
|
---
|
|
|
|
<p align="center">
|
|
<a href="https://www.qpm.io/packages/com.github.simonbrunel.qtpromise/index.html"><img src="https://img.shields.io/github/release/simonbrunel/qtpromise.svg?style=flat-square&label=qpm&colorB=4CAF50&maxAge=600" alt="Install"></a>
|
|
<a href="https://travis-ci.org/simonbrunel/qtpromise"><img src="https://img.shields.io/travis/simonbrunel/qtpromise/master.svg?style=flat-square&maxAge=600" alt="Builds"></a>
|
|
<a href="https://codecov.io/gh/simonbrunel/qtpromise"><img src="https://img.shields.io/codecov/c/github/simonbrunel/qtpromise.svg?style=flat-square&maxAge=600" alt="Coverage"></a>
|
|
<a href="https://marketplace.qt.io/products/qtpromise"><img src="https://img.shields.io/static/v1?style=flat-square&label=Qt&message=Marketplace&colorB=40cd52&maxAge=600" alt="Marketplace"></a>
|
|
</p>
|
|
|
|
## Overview
|
|
|
|
[Promises/A+](https://promisesaplus.com/) implementation for [Qt/C++](https://www.qt.io/).
|
|
|
|
Requires [Qt 5.6](https://www.qt.io/download/) (or later) with [C++11 support enabled](https://wiki.qt.io/How_to_use_C++11_in_your_Qt_Projects).
|
|
|
|
## Documentation
|
|
|
|
- [Getting Started](/qtpromise/getting-started.md)
|
|
- [Qt Concurrent](/qtpromise/qtconcurrent.md)
|
|
- [Qt Signals](/qtpromise/qtsignals.md)
|
|
- [Thread-Safety](/qtpromise/thread-safety.md)
|
|
- [API Reference](/qtpromise/api-reference.md)
|
|
|
|
## License
|
|
|
|
QtPromise is available under the [MIT license](https://github.com/simonbrunel/qtpromise/blob/master/LICENSE).
|