change readme

[apps/onscreenapp.git] / doc / readme.md

diff --git a/sample/readme.md b/doc/readme.md
similarity index 79%
rename from sample/readme.md
rename to doc/readme.md
index a48f3e0..0b6ba93 100644 (file)
--- a/sample/readme.md
+++ b/doc/readme.md
@@ -1,15 +1,7 @@
 
-A test application for onscreenapp
+usage of 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`
-
 ## dependence
 
 Onscreenapp depend on libhomescreen add agl-service-homescreen as below:
@@ -17,7 +9,22 @@ Onscreenapp depend on libhomescreen add agl-service-homescreen as below:
        and 'showWindow/hideWindow/replyShowWindow' interface.
 - agl-service-homescreen must have 'showWindow/hideWindow/replyShowWindow' verbs.
 
-## usage
+## 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
 
 Before start onstestapp you must copy all files in "qml" folder to "$HOME/app-data/OnScreen/onstestapp/" on your board(R-car M3 etc.),
 then do as below:
@@ -26,7 +33,7 @@ then do as below:
 2. select onscreen type
 3. press "Post" button
 
-## edit parameter with keyboard
+### edit parameter with keyboard
 
 You also can edit the text which will post to onscreen, do as below: