X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;ds=sidebyside;f=doc%2Freadme.md;fp=doc%2Freadme.md;h=f9da853d4860000463e07f123ccd2bc53ad7c242;hb=aee1b69e8e207081a3d8b2670980671a9fbc78b8;hp=0000000000000000000000000000000000000000;hpb=483c21f9d648f2cd58e00f39fcbee7b5dcbe2bc5;p=apps%2Fonscreenapp.git

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.