Add the .gbs.conf

[profile/ivi/wayland-ivi-extension.git] / README

diff --git a/README b/README
index 5a74048..0f4b495 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,54 @@
-IVI Extension for Wayland
-=========================
+Sections in this file describe:
+- How to build 
+- Example applications
+
+How to build on different platforms
+====================================
+
+Pre-requisite: 
+- Weston works with any shell downloaded from the following URL
+  http://cgit.freedesktop.org/wayland/weston/
+- CMake required (version 2.6 or higher)
+
+Build up
+1. Pull the current codebase form the git repo
+   E.g. git clone http://git.projects.genivi.org/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> ../
+
+   Example of *.cmake
+
+add_definitions ("-g -O3")
+set (CMAKE_FIND_ROOT_PATH <your root path>)
+set (CMAKE_INSTALL_PREFIX <your installation path>)
+set (FFI_INCLUDE_DIR /usr/lib/libffi-3.0.10/include)
+set (XKB_INCLUDE_DIR <your installation path>/include/xkbcommon)
+set (CAIRO_INCLUDE_DIR <your installation path>/include/cairo)
+
+4. Start the build and install
+   
+   E.g. sudo make install
+
+Example applications
+====================================
+  
+Pre-requisite:
+- Modify weston.ini to use ivi-shell.so
+  Example:
+    shell=ivi-shell.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
+
+EGLWLMockNavigation:
+   Example: <your installation path>/bin/EGLWLMockNavigation
 
-Directory       Content
--------------------------------------------------------------------------------
-protocol        This directory contains the protocol specification for the
-                Wayland IVI extension.