update

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

diff --git a/sample/readme.md b/sample/readme.md
new file mode 100644 (file)
index 0000000..ae6d0da
--- /dev/null
+++ b/sample/readme.md
@@ -0,0 +1,37 @@
+
+A test application for onscreenapp
+===
+
+## compile & install
+
+- compile
+       - when onscreenapp is compiled, this app's wgt file will exist at "onscreenapp/sample/package", called onstestapp.wgt.
+
+- install
+:              `afm-util install onstestapp.wgt;sync`
+
+## dependence
+
+Onscreenapp depend on libhomescreen add agl-service-homescreen-2017 as below:
+- libhomescreen must have 'showWindow' event and 'showWindow' interface.
+- agl-service-homescreen-2017 must have 'showWindow/hideWindow/replyShowWindow' verbs.
+
+
+## usage
+
+Before start onstestapp you must copy all files in "ons" folder to "$HOME/app-data/OnScreen/qml" 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 qt virtual keyboard and edit text.
+