Rewrite README.md
It was added by the qtquickcontrols2 merge and was out-dated. To ease maintenance while still providing some benefit to users, let's just link to the Qt documentation for all modules. Fixes: QTBUG-95414 Pick-to: 6.2 Change-Id: I4e2a75158c2c813c1689f628974d544278ab4e75 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
This commit is contained in:
Mitch Curtis
parent
9738d49b65
commit
4da27ae0c0
77
README.md
77
README.md
|
|
@ -1,57 +1,28 @@
|
|||
Qt Quick Controls 2
|
||||
===================
|
||||
qtdeclarative
|
||||
=============
|
||||
|
||||
|
||||
The qtdeclarative repository is home to QML, Qt Quick and several related modules:
|
||||
|
||||
The Qt Quick Controls 2 module delivers the next generation user interface
|
||||
controls based on Qt Quick. In comparison to the desktop-oriented Qt Quick
|
||||
Controls 1, Qt Quick Controls 2 are an order of magnitude simpler, lighter and
|
||||
faster, and are primarily targeted towards embedded and mobile platforms.
|
||||
- [Qt QML](https://doc.qt.io/qt-6/qtqml-index.html)
|
||||
- [Qt QML Core](https://doc.qt.io/qt-6/qtqmlcore-index.html)
|
||||
- [Qt QML Models](https://doc.qt.io/qt-6/qtqml-models-qmlmodule.html)
|
||||
- [Qt QML WorkerScript](https://doc.qt.io/qt-6/qml-qtqml-workerscript-workerscript.html)
|
||||
- [Qt QML XmlListModel](https://doc.qt.io/qt-6/qml-qtqml-xmllistmodel-xmllistmodel.html)
|
||||
- [Qt Quick](https://doc.qt.io/qt-6/qtquick-index.html)
|
||||
- [Qt Quick Controls 2](https://doc.qt.io/qt-6/qtquickcontrols-index.html)
|
||||
- [Qt Quick Layouts](https://doc.qt.io/qt-6/qtquicklayouts-index.html)
|
||||
- [Qt Quick Local Storage](https://doc.qt.io/qt-6/qtquick-localstorage-qmlmodule.html)
|
||||
- [Qt Quick Particles](https://doc.qt.io/qt-6/qtquick-particles-qmlmodule.html)
|
||||
- [Qt Quick Shapes](https://doc.qt.io/qt-6/qtquick-shapes-qmlmodule.html)
|
||||
- [Qt Quick Templates](https://doc.qt.io/qt-6/qtquick-templates2-qmlmodule.html)
|
||||
- [Qt Quick Test](https://doc.qt.io/qt-6/qtquicktest-index.html)
|
||||
|
||||
Qt Quick Controls 2 are based on a flexible template system that enables rapid
|
||||
development of entire custom styles and user experiences. Qt Quick Controls 2
|
||||
comes with a selection of built-in styles:
|
||||
In addition, there are several Qt Labs modules:
|
||||
|
||||
- Default style - a simple and minimal all-round style that offers the maximum performance
|
||||
- Fusion style - a platform-agnostic style that offers a desktop-oriented look and feel
|
||||
- Imagine style - a designer-friendly style based on image assets
|
||||
- Material style - a style based on the Google Material Design Guidelines
|
||||
- Universal style - a style based on the Microsoft Universal Design Guidelines
|
||||
- Windows style - a style that looks native on Windows
|
||||
- macOS style - a style that looks native on macOS
|
||||
|
||||
More information can be found in the following blog posts:
|
||||
|
||||
- http://blog.qt.io/blog/2015/03/31/qt-quick-controls-for-embedded/
|
||||
- http://blog.qt.io/blog/2015/11/23/qt-quick-controls-re-engineered-status-update/
|
||||
- http://blog.qt.io/blog/2016/06/10/qt-quick-controls-2-0-a-new-beginning/
|
||||
- http://blog.qt.io/blog/2016/10/06/qt-quick-controls-2-1-and-beyond/
|
||||
- http://blog.qt.io/blog/2017/05/31/ready-made-ui-controls-qt-quick-controls-2-summary/
|
||||
- http://blog.qt.io/blog/2017/11/23/qt-quick-controls-2-imagine-style/
|
||||
- http://blog.qt.io/blog/2017/11/23/ready-qt-quick-controls-2-3/
|
||||
|
||||
## Help
|
||||
|
||||
If you have problems or questions, don't hesitate to:
|
||||
|
||||
- ask on the Qt Interest mailing list http://lists.qt-project.org/mailman/listinfo/interest
|
||||
- ask on the Qt Forum http://forum.qt.io/category/12/qt-quick
|
||||
- report issues to the Qt Bug Tracker https://bugreports.qt.io (component: *Qt Quick: Controls 2*)
|
||||
|
||||
## Installation
|
||||
|
||||
The MINIMUM REQUIREMENT for building this project is to use the same branch
|
||||
of Qt 5. The dependencies are *qtbase* and *qtdeclarative*.
|
||||
|
||||
To install the controls into your Qt directory (```QTDIR/qml```):
|
||||
|
||||
qmake
|
||||
make
|
||||
make install
|
||||
|
||||
If you are compiling against a system Qt on Linux, you might have to use
|
||||
```sudo make install``` to install the project.
|
||||
|
||||
## Usage
|
||||
|
||||
Please refer to the [Getting Started with Qt Quick Controls 2](https://doc.qt.io/qt-5/qtquickcontrols2-gettingstarted.html) documentation.
|
||||
- [Qt Labs Animation](https://doc.qt.io/qt-6/qt-labs-animation-qmlmodule.html)
|
||||
- [Qt Labs FolderListModel](https://doc.qt.io/qt-6/qml-qt-labs-folderlistmodel-folderlistmodel.html)
|
||||
- [Qt Labs Platform](https://doc.qt.io/qt-6/qtlabsplatform-index.html)
|
||||
- [Qt Labs Models](https://doc.qt.io/qt-6/qtqml-models-qmlmodule.html)
|
||||
- [Qt Labs Settings](https://doc.qt.io/qt-6/qml-qt-labs-settings-settings.html)
|
||||
- [Qt Labs Shared Image Provider](https://doc.qt.io/qt-6/qt-labs-sharedimage-qmlmodule.html)
|
||||
- [Qt Labs WavefrontMesh](https://doc.qt.io/qt-6/qt-labs-wavefrontmesh-qmlmodule.html)
|
||||
|
|
|
|||
Loading…
Reference in New Issue