From: wang_zhiqiang <wang_zhiqiang@dl.cn.nexty-ele.com>
Date: Mon, 3 Dec 2018 05:18:47 +0000 (+0800)
Subject: change readme
X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?p=apps%2Fonscreenapp.git;a=commitdiff_plain;h=f42ae47fe425b8ef353ec72ff9edaff451206cb8

change readme
---

diff --git a/doc/parts/show_hide_onscreen.png b/doc/parts/show_hide_onscreen.png
deleted file mode 100644
index 933540e..0000000
Binary files a/doc/parts/show_hide_onscreen.png and /dev/null differ
diff --git a/doc/parts/show_hide_onscreen.pu b/doc/parts/show_hide_onscreen.pu
deleted file mode 100644
index b72ccb1..0000000
--- a/doc/parts/show_hide_onscreen.pu
+++ /dev/null
@@ -1,80 +0,0 @@
-@startuml
-
-title Show/Hide Onscreenapp Sequence
-
-actor User
-entity HomeScreen_Service as HSS
-entity App
-entity Onscreenapp
-entity WindowManagere as WM
-
-== show Onscreenapp ==
-User->App: display Onscreenapp by user operation
-App->HSS: subscribe replyShowWindow event
-App->HSS: call showWindow()
-note right
-{ "application_id": "onscreenapp", 
-  "parameter": { 
-    "file": "qml file path", 
-    "data": {...}
-  }
-}
-end note
-HSS->HSS: get app's id
-HSS->Onscreenapp: push showWindow event
-note right
-{ "application_id": "onscreenapp", 
-  "parameter": {
-    "file": "qml file path", 
-    "data": {...},
-    "replyid": "app's id"
- }
-}
-end note
-Onscreenapp->WM: activateWindow("on_screen.app")
-
-alt display able
-WM->Onscreenapp: SyncDraw
-Onscreenapp->Onscreenapp: load app's qml
-Onscreenapp->WM: EndDraw("on_screen.app")
-WM->Onscreenapp: VISIBLE("on_screen.app")
-
-else display disable
-rnote over Onscreenapp
-do nothing
-end rnote
-end
-
-== hide Onscreenapp ==
-alt touch Onscreenapp's button
-User->Onscreenapp: touch Onscreenapp's button
-Onscreenapp->WM: deactivateWindow("on_screen.app")
-Onscreenapp->Onscreenapp: unload qml
-Onscreenapp->HSS: call replyShowWindow()
-note right
-{ "application_id": "app's id", 
-  "parameter": {
-    "method": "Buttons.ButtonPress", 
-    "buttonName": "pressed button name", 
-    "buttonPressMode": "Short"
- }
-}
-end note
-WM->Onscreenapp: INVISIBLE("on_screen.app")
-HSS->App: push replyShowWindow event
-App->App: call button function
-
-else hide by App
-
-App->HSS: call hideWindow("onscreenapp")
-note right
-{ "application_id": "onscreenapp"}
-end note
-HSS->Onscreenapp: push hideWindow event
-Onscreenapp->Onscreenapp: unload qml
-Onscreenapp->WM: deactivateWindow("on_screen.app")
-WM->Onscreenapp: INVISIBLE("on_screen.app")
-
-end
-
-@enduml
diff --git a/doc/parts/startup.png b/doc/parts/startup.png
deleted file mode 100644
index b292357..0000000
Binary files a/doc/parts/startup.png and /dev/null differ
diff --git a/doc/parts/startup.pu b/doc/parts/startup.pu
deleted file mode 100644
index 95c9f95..0000000
--- a/doc/parts/startup.pu
+++ /dev/null
@@ -1,33 +0,0 @@
-@startuml
-
-title Onscreenapp Startup Sequence
-
-entity Systemd
-entity HomeScreen_Service
-entity Onscreenapp
-entity WindowManager as WM
-
-== System StartUp ==
-
-Systemd->Onscreenapp: start
-
-group WindowManger Initilize
-Onscreenapp->WM: init(port, token)
-Onscreenapp->WM: requestSurface("on_screen.app")
-rnote over WM
-WM process
-end rnote
-Onscreenapp<--WM: return SurfaceID
-Onscreenapp->WM: subscribe Event_SyncDraw
-Onscreenapp->WM: subscribe Event_Visible
-Onscreenapp->WM: subscribe Event_Invisible
-end
-
-group HomeScreen_Service Initilize
-Onscreenapp->HomeScreen_Service: init(port, token)
-Onscreenapp->HomeScreen_Service: subscribe showWindow Event
-Onscreenapp->HomeScreen_Service: subscribe hideWindow Event
-Onscreenapp->Onscreenapp: qmlLoad()
-end
-
-@enduml
\ No newline at end of file
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
--- 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: