amass/qtpromise
1
0
Fork 0
mirror of https://github.com/simonbrunel/qtpromise.git synced 2024-11-22 02:34:30 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
ac9b936959
qtpromise/README.md

29 lines
1.6 KiB
Markdown
Raw Normal View History

Enhance the documentation and add markdown lint - Add npm package.json to make easier maintaining dependencies. - Make markdown files consistent using remark. - Wrap markdown lines to 100 characters. - Better README.md layout and visual. - Enable VuePress landing/home page. - Upgrade to latest VuePress version. - Add link to the new Qt Marketplace.
2019-12-21 17:27:26 +08:00
<p align="center">
<img width="256" src="docs/.vuepress/public/hero.svg?sanitize=true">
</p>
Initial implementation
2017-05-15 01:03:01 +08:00
Enhance the documentation and add markdown lint - Add npm package.json to make easier maintaining dependencies. - Make markdown files consistent using remark. - Wrap markdown lines to 100 characters. - Better README.md layout and visual. - Enable VuePress landing/home page. - Upgrade to latest VuePress version. - Add link to the new Qt Marketplace.
2019-12-21 17:27:26 +08:00
<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>
Upgrade npm dependencies for security fixes
2020-10-02 04:54:58 +08:00
<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>
Enhance the documentation and add markdown lint - Add npm package.json to make easier maintaining dependencies. - Make markdown files consistent using remark. - Wrap markdown lines to 100 characters. - Better README.md layout and visual. - Enable VuePress landing/home page. - Upgrade to latest VuePress version. - Add link to the new Qt Marketplace.
2019-12-21 17:27:26 +08:00
<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>
Migrate documentation to VuePress GitBook development seems a bit stuck right now so let's switch to VuePress which, IMO, is more user friendly. Update the documentation to include the version number in which features were added and use custom container to display notes and warnings.
2018-09-07 23:50:09 +08:00
Enhance the documentation and add markdown lint - Add npm package.json to make easier maintaining dependencies. - Make markdown files consistent using remark. - Wrap markdown lines to 100 characters. - Better README.md layout and visual. - Enable VuePress landing/home page. - Upgrade to latest VuePress version. - Add link to the new Qt Marketplace.
2019-12-21 17:27:26 +08:00
## Overview
Setup Travis CI builds and code coverage Built with Qt 5.4.2/GCC 4.8.4, code coverage with LCOV 1.13 and reported to Codecov.
2017-05-26 16:29:58 +08:00
[Promises/A+](https://promisesaplus.com/) implementation for [Qt/C++](https://www.qt.io/).
Add support for Qt 6
2022-06-27 00:10:20 +08:00
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/).
Add usage and API documentation (basic)
2017-06-04 16:29:41 +08:00
New documentation based on GitBook CLI Split the root README.md in multiple Markdown files (in the `docs/` folder) to make easier reading, editing and extending the documentation. An online version is also available on netlify (https://qtpromise.netlify.com). Building it requires Node.js installed, then: - npm install -g gitbook-cli - gitbook install ./ - gitbook build . dist/docs
2018-02-11 23:19:03 +08:00
## Documentation
Add usage and API documentation (basic)
2017-06-04 16:29:41 +08:00
Enhance the documentation and add markdown lint - Add npm package.json to make easier maintaining dependencies. - Make markdown files consistent using remark. - Wrap markdown lines to 100 characters. - Better README.md layout and visual. - Enable VuePress landing/home page. - Upgrade to latest VuePress version. - Add link to the new Qt Marketplace.
2019-12-21 17:27:26 +08:00
- [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)
Initial implementation
2017-05-15 01:03:01 +08:00
## License
Migrate documentation to VuePress GitBook development seems a bit stuck right now so let's switch to VuePress which, IMO, is more user friendly. Update the documentation to include the version number in which features were added and use custom container to display notes and warnings.
2018-09-07 23:50:09 +08:00
Add qpm package.json and docs
2017-06-10 17:27:38 +08:00
QtPromise is available under the [MIT license](LICENSE).
Reference in New Issue Copy Permalink