qtpromise/README.md
2022-06-26 18:10:20 +02:00

29 lines
1.6 KiB
Markdown

<p align="center">
<img width="256" src="docs/.vuepress/public/hero.svg?sanitize=true">
</p>
<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.com/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://doc.qt.io/qt-5/) (or later) with [C++11 support enabled](https://wiki.qt.io/How_to_use_C++11_in_your_Qt_Projects) or [Qt 6](https://doc.qt.io/qt-6/).
## Documentation
- [Getting Started](https://qtpromise.netlify.com/qtpromise/getting-started.html)
- [Qt Concurrent](https://qtpromise.netlify.com/qtpromise/qtconcurrent.html)
- [Qt Signals](https://qtpromise.netlify.com/qtpromise/qtsignals.html)
- [Thread-Safety](https://qtpromise.netlify.com/qtpromise/thread-safety.html)
- [API Reference](https://qtpromise.netlify.com/qtpromise/api-reference.html)
## License
QtPromise is available under the [MIT license](LICENSE).