Add gitreview file for Magic Marlin branch
[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 - start onstestapp in launcher
29 - select onscreen type in groupbox
30 - press "Post" button
31
32 After clicked onscreen's button,you will see reply information at top area of onstestapp.