Sections in this file describe:
- How to build
- Example applications
- How to test

How to build on different platforms
====================================

Pre-requisite:
- Weston
- CMake required (version 2.6 or higher)
- Open GLES and EGL for example applications
- Gtest for the test suite

Build up
1. Pull the current codebase form the git repo
   E.g. git clone https://github.com/GENIVI/wayland-ivi-extension.git

2. Create a build directory
   E.g mkdir build_ivi_extension

3. In <build-dir> Generate build system for your platform using CMake.
   E.g. cd <build-dir>
        cmake -DCMAKE_TOOLCHAIN_FILE=<your setting *.cmake> ../

4. Start the build and install

   E.g. sudo make install

Example applications
====================================

Pre-requisite:
- Modify weston.ini to use ivi-shell.so
  Example:
    [core]
    shell=ivi-shell.so
    modules=ivi-controller.so

    [ivi-shell]
    ivi-input-module=ivi-input-controller.so

- Set Environmental values
  Example:
    export XDG_RUNTIME_DIR=/var/run/<your user name>/1000
    export LD_LIBRARY_PATH=<your installation path>/lib

Start-up Weston:
   Example: <your installation path>/bin/weston

Start-up HMI helper:
   Example: <your installation path>/bin/layer-add-surfaces 1000 1

EGLWLMockNavigation:
   Example: <your installation path>/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

[
    {
        "Name": "wayland-ivi-extension",
        "License": "Apache License V2.0",
        "License File": "LICENSE",
        "Version Number": "2.2.0",
        "Owner": "lizheng2@huawei.com",
        "Upstream URL": "https://github.com/GENIVI/wayland-ivi-extension/archive/refs/tags/2.2.0_weston_5_compartible.zip",
        "Description": "This Project provides a possibility to control IVI applications with well known ILM interface with was first implemented in IVI Layer Manager."
    }
]