change readme

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

diff --git a/doc/readme.md b/doc/readme.md
new file mode 100644 (file)
index 0000000..0b6ba93
--- /dev/null
+++ b/doc/readme.md
@@ -0,0 +1,44 @@
+
+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
+
+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:
+
+1. start onstestapp in launcher
+2. select onscreen type
+3. press "Post" button
+
+### edit parameter with keyboard
+
+You also can edit the text which will post to onscreen, do as below:
+
+- comment below contents in /etc/xdg/weston/weston.ini
+       - `#ivi-input-module=ivi-input-controller.so`
+
+- before press "Post" button, touch text area to call keyboard and edit the text.
+