RunXDG
[staging/xdg-launcher.git] / README.txt
1 How to build with SDK
2
3 1. make build directory
4    $ mkdir build
5
6 2. do cmake
7    $ cd build
8    $ cmake ..
9
10    You could find binary executable "runxdg" is built.
11    "runxdg" should be installed into the directory
12    on the target. (e.g. /usr/bin or /usr/local/bin)
13
14 3. Prepare configuration for RunXDG, 'runxdg.toml'
15    See 'package/{runxdg|navi|hvac}/runxdg.toml for detail.
16
17    'role', 'method', 'path' is mondatory.
18
19    Only "POSIX" as 'method' works, others not tested so far.
20
21    'role' should be the same which defined in layers.json of WindowManager.
22
23    e.g. followings are predefined role by default
24    "role": "MediaPlayer|Radio|Phone|Navigation|HVAC|Settings|Dashboard|POI|Mixer"
25
26 3. Prepare config.xml for widget
27
28    <content> should be follow.
29      <content src="bin/runxdg" type="application/vnd.agl.native"/>
30
31    following <feature> is mandatory.
32      <feature name="urn:AGL:widget:required-api">
33        <param name="homescreen" value="ws" />
34        <param name="windowmanager" value="ws" />
35      </feature>
36
37 4. Make widgets
38    $ make widget
39
40    The following wgt would be made.
41    - runxdg.wgt     XDG Launcher
42    - navi.wgt       for test, XDG Launcher installed as Navigation
43    - hvac.wgt       for test, XDG Lanncher installed as HVAC
44