summaryrefslogtreecommitdiffstats
path: root/doc/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/readme.md')
-rw-r--r--doc/readme.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/readme.md b/doc/readme.md
new file mode 100644
index 0000000..f9da853
--- /dev/null
+++ b/doc/readme.md
@@ -0,0 +1,32 @@
+
+usage of onscreenapp
+===
+
+## dependence
+
+- Onscreenapp depend on libhomescreen add agl-service-homescreen as below:
+ - libhomescreen must have 'showWindow/hideWindow/replyShowWindow' event
+ and 'showWindow/hideWindow/replyShowWindow' interface.
+ - agl-service-homescreen must have 'showWindow/hideWindow/replyShowWindow' verbs.
+
+## sequence
+
+show/hide onscreen sequence.
+- ![showOnscreen.svg](parts/showOnscreen.svg)
+
+## about sample 'onstestapp'
+onstestapp is a sample to use onscreenapp.
+
+### compile & install
+- compile
+ - when onscreenapp is compiled, this app's wgt file will exist at "onscreenapp/sample/package" which called onstestapp.wgt.
+
+- install
+ `afm-util install onstestapp.wgt;sync`
+
+### onstestapp usage
+- start onstestapp in launcher
+- select onscreen type in groupbox
+- press "Post" button
+
+After clicked onscreen's button,you will see reply information at top area of onstestapp.