summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorzheng_wenlong <wenlong_zheng@nexty-ele.com>2019-05-14 10:33:41 +0900
committerzheng_wenlong <wenlong_zheng@nexty-ele.com>2019-05-15 09:59:04 +0900
commite47b4736452c263d21c4d08767071346f1f30a1c (patch)
treec0888f1f65216eeb78259dbde13b63e8522f6cc2
parent07f4c99e9d88ee47f2b5e8b81419eb5888e3b52f (diff)
Change README.md syntax to suit common markdown syntax. Bug-AGL: SPEC-2103 Change-Id: Ibb6998c5763a572a2eb1652ddbcd8ee06423ca74 Signed-off-by: wang_zhiqiang <wang_zhiqiang@dl.cn.nexty-ele.com> Signed-off-by: zheng_wenlong <wenlong_zheng@nexty-ele.com>
-rw-r--r--README.md72
1 files changed, 34 insertions, 38 deletions
diff --git a/README.md b/README.md
index 5d54cc6..9b52294 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,10 @@
-Information
-====
-<br>This service use logitel G29 to get wheel info for application same as low-level-can-service.
-<br>It will read information from usb g29 as /dev/input/js0.
-<br>And give steering wheel information for application.
+# Information
+ This service use logitel G29 to get wheel info for application same as low-level-can-service.
+ It will read information from usb g29 as /dev/input/js0.
+ And give steering wheel information for application.
* Hardware: Renesas m3ulcb
-* Software: Daring Dab 4.0.0
+* Software: HH 8.0.0
* binding name: af-steering-wheel-binding
* provide api: steering-wheel
* verbs: list, subscribe, unsubscribe
@@ -24,38 +23,35 @@ Information
* subscribe { "event" : "EngineSpeed" }
* unsubscribe { "event" : "EngineSpeed" }
-How to compile and install
-====
-<br> These is a sample recipes for af-steering-wheel-binding, you can just add that recipes into your project and bitbake.
-<br> Sample Recipes: agl-service-steering-wheel_0.1.bb
+# How to compile and install
+ These is a sample recipes for af-steering-wheel-binding, you can just add that recipes into your project and bitbake.
+ Sample Recipes: agl-service-steering-wheel_0.1.bb
-How to use
-====
-For AGL Application
-----
-<br>1 add these code below into config.xml
-```
+# How to use
+
+## For AGL Application
+1 add these code below into config.xml
+ ```
<param name="steering-wheel" value="ws"/>
-```
-<br>2 add WebSocket into qml file and subscribe event name what you need.
-<br>You can find a file named [token-websock.qml] in app-framework-binder.git.
-<br>It's a template for qml. You need modify these informations to connect agl-service-steering.
-```
-property string address_str: "ws://localhost:5555/api?token=3210"
-property string api_str: "steering-wheel"
-property string verb_str: ""
-```
+ ```
+2 add WebSocket into qml file and subscribe event name what you need.
+ You can find a file named [token-websock.qml] in app-framework-binder.git.
+ It's a template for qml. You need modify these informations to connect agl-service-steering.
+ ```
+ property string address_str: "ws://localhost:5555/api?token=3210"
+ property string api_str: "steering-wheel"
+ property string verb_str: ""
+ ```
-For demo application
-----
-<br>1 you can run this service by shell script
-```
-afb-daemon --token=3210 --ldpaths=${steering-wheel-library-path} --port=5555 --rootdir=. &
-```
-<br>2 use afb-client-demo to get event.
-```
-afb-client-demo ws://localhost:5555/api?token=3210
-steering-wheel list
-steering-wheel subscribe { "event" : "EngineSpeed" }
-steering-wheel unsubscribe { "event" : "EngineSpeed" }
-```
+## For demo application
+1 you can run this service by shell script
+ ```
+ afb-daemon --token=3210 --ldpaths=${steering-wheel-library-path} --port=5555 --rootdir=. &
+ ```
+2 use afb-client-demo to get event.
+ ```
+ afb-client-demo ws://localhost:5555/api?token=3210
+ steering-wheel list
+ steering-wheel subscribe { "event" : "EngineSpeed" }
+ steering-wheel unsubscribe { "event" : "EngineSpeed" }
+ ```