Change local variable name
[apps/agl-service-windowmanager.git] / client / README
1 = Example Application for TMC AGL WindowManager Client Lib 
2 This is a example QML application that uses clients of the TMC WindowManager.
3
4 == Dependencies
5 * Qt5 + QtQuick (QML) with ivi-shell support
6
7 == Build instructions
8 Inside of an SDK environment run:
9
10 ----------------
11 qmake
12 make
13 ----------------
14
15 * The binary should be installed somewhere in $PATH
16
17 == Usage
18 Run this application like follows:
19
20 ----------------
21 qmlWindowManagerSampleApp $width $height $appLabel $colorName
22 ----------------
23
24 .Note
25 ****************
26 Depending on your environment you will need to set the following
27 environment variable to instruct Qt to use the ivi-shell integration:
28 `QT_WAYLAND_SHELL_INTEGRATION=ivi-shell`
29 ****************
30
31 Starts the application with a surface the size $width x $height
32 the Surface will request the label "$appLabel" and set its surface
33 color "$colorName" e.g. red.
34
35 Note, that although the application sets an initial window size, the
36 window manager will send events to the application that instruct it to
37 set the proper, requested size for the layout.
38
39 // vim:set tw=72 ft=asciidoc: