From e454e0ed9080b740c74eac99d7805fe7bba12dbe Mon Sep 17 00:00:00 2001
From: "Tran Ba Khang(MS/EMC31-XC)" <Khang.TranBa@vn.bosch.com>
Date: Wed, 7 Dec 2022 10:37:11 +0700
Subject: README: update for wayland backend

On Ubuntu 22.04, the display controller are using the wayland protocols
by default. Run a new weston process need to pass the wayland display
socket listening. Clients want to run with new weston process need to
set WAYLAND_DISPLAY environment variable.

Signed-off-by: Tran Ba Khang(MS/EMC31-XC) <Khang.TranBa@vn.bosch.com>
---
 README | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/README b/README
index c188767..fba7797 100644
--- a/README
+++ b/README
@@ -46,17 +46,21 @@ Pre-requisite:
     export LD_LIBRARY_PATH=<your installation path>/lib 
 
 Start-up Weston:
-   Example: <your installation path>/bin/weston
+   Syntax:  <your installation path>/bin/weston [wayland_display_to_listen_on]
+   Example: /usr/bin/weston -Swayland-1
 
 Start-up HMI helper:
-   Example: <your installation path>/bin/layer-add-surfaces 1000 1
+   Syntax:  [wayland_display_to_connect_to] <your installation path>/bin/layer-add-surfaces <layer_id> <surface_count>
+   Example: WAYLAND_DISPLAY=wayland-1 $HOME/bin/layer-add-surfaces 1000 1
 
 EGLWLMockNavigation:
-   Example: <your installation path>/bin/EGLWLMockNavigation
+   Syntax:  [wayland_display_to_connect_to] <your installation path>/bin/EGLWLMockNavigation
+   Example: WAYLAND_DISPLAY=wayland-1 $HOME/bin/EGLWLMockNavigation
 
 How to test
 ====================================
 1. Build the testsuite by setting BUILD_ILM_API_TESTS option.
    Example: cmake -DBUILD_ILM_API_TESTS
 2. After starting up Weston run the testsuite.
-   Example: <your installation path>/bin/ivi-layermanagement-api-test
+   Syntax:  [wayland_display_to_connect_to] <your installation path>/bin/ivi-layermanagement-api-test
+   Example: WAYLAND_DISPLAY=wayland-1 $HOME/bin/ivi-layermanagement-api-test
-- 
cgit v1.2.1