change qml folder to
[apps/onscreenapp.git] / doc / readme.md
1
2 usage of onscreenapp
3 ===
4
5 ## dependence
6
7 Onscreenapp depend on libhomescreen add agl-service-homescreen as below:
8 - libhomescreen must have 'showWindow/hideWindow/replyShowWindow' event 
9         and 'showWindow/hideWindow/replyShowWindow' interface.
10 - agl-service-homescreen must have 'showWindow/hideWindow/replyShowWindow' verbs.
11
12 ## sequence
13
14 show/hide onscreen sequence.
15 - ![showOnscreen.svg](parts/showOnscreen.svg)
16
17 ## about sample 'onstestapp'
18 onstestapp is a sample to use onscreenapp.
19
20 ### compile & install
21 - compile
22         - when onscreenapp is compiled, this app's wgt file will exist at "onscreenapp/sample/package" which called onstestapp.wgt.
23
24 - install
25                 `afm-util install onstestapp.wgt;sync`
26
27 ### onstestapp usage
28
29 Before start onstestapp you must copy all files in "qml" folder to "$HOME/app-data/OnScreen/onstestapp/" on your board(R-car M3 etc.),
30 then do as below:
31
32 1. start onstestapp in launcher
33 2. select onscreen type
34 3. press "Post" button
35
36 ### edit parameter with keyboard
37
38 You also can edit the text which will post to onscreen, do as below:
39
40 - comment below contents in /etc/xdg/weston/weston.ini
41         - `#ivi-input-module=ivi-input-controller.so`
42
43 - before press "Post" button, touch text area to call keyboard and edit the text.
44