aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJ-P Nurmi <jpnurmi@theqtcompany.com>2016-01-30 09:45:43 +0100
committerJ-P Nurmi <jpnurmi@theqtcompany.com>2016-01-30 11:50:41 +0000
commit6bfcaea4c2d7d2efee9aab3bf3e20bf63f65abf3 (patch)
treee9803ece79d059e1a41129a741feb3feaecc981a /README.md
parentbb06d8913c4e781a37db100e2619a236a93b38a9 (diff)
Update README.md
Change-Id: I323f708c857366c0b50d143d67b96bee3f7a1a98 Reviewed-by: J-P Nurmi <jpnurmi@theqtcompany.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 15 insertions, 7 deletions
diff --git a/README.md b/README.md
index 03d9724f..1c67b728 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,14 @@ oriented Qt Quick Controls 1, the experimental Qt Labs Controls are an order
of magnitude simpler, lighter and faster, and are primarily targeting embedded
and mobile platforms.
+Qt Labs Controls are based on a flexible template system that enables rapid
+development of entire custom styles and user experiences. Qt Labs Controls
+comes with a selection of built-in styles:
+
+- Default style - a simple and minimal all-round style that offers the maximum performance
+- Material style - a style based on the Google Material Design Guidelines
+- Universal style - a style based on the Microsoft Universal Design Guidelines
+
More information can be found in the following blog posts:
- http://blog.qt.io/blog/2015/03/31/qt-quick-controls-for-embedded/
@@ -16,24 +24,24 @@ More information can be found in the following blog posts:
If you have problems or questions, don't hesitate to:
-- ask on the Qt Interest mailing list interest@qt-project.org
+- 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)
+- 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, qtxmlpatterns and qtdeclarative. Other
-optional dependencies are qtgraphicaleffects for the Material style and
-qtquickcontrols for the Qt Quick Layouts.
+of Qt 5. The dependencies are *qtbase*, *qtxmlpatterns* and *qtdeclarative*.
+Other optional dependencies include *qtgraphicaleffects* for the Material
+style and *qtquickcontrols* for the Qt Quick Layouts.
-To install the controls into your Qt directory (QTDIR/qml):
+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
+If you are compiling against a system Qt on Linux, you might have to use
```sudo make install``` to install the project.
## Usage