summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarcus Fritzsch <marcus_fritzsch@mentor.com>2017-09-05 13:40:47 +0200
committerMarcus Fritzsch <marcus_fritzsch@mentor.com>2017-09-05 13:41:57 +0200
commit20512fd4b4e75e0c375246a5f0c97d8330b7e6e4 (patch)
tree066f4e3cf2d801124644f305c0b76b0e06ebf214
parent76fb6aef7ca4cf8f922a1076eaafef3c19e3fd07 (diff)
README: update
Signed-off-by: Marcus Fritzsch <marcus_fritzsch@mentor.com>
-rw-r--r--README15
1 files changed, 9 insertions, 6 deletions
diff --git a/README b/README
index 51cc0c8..f7146a9 100644
--- a/README
+++ b/README
@@ -56,16 +56,19 @@ Running
Prerequisites: a compositor implementing the ivi_controller interface must
be running and XDG_RUNTIME_DIR must be set so the wayland socket can be found.
+The configuration for the window manager (the layers.json file, as specified
+int the next section) needs to be available. The environment variable
+LAYERS_JSON=/path/to/layers.json needs to be set.
+
To run from the build directory use:
-afb-daemon --ldpaths=$PWD/src
+env LAYERS_JSON=/path/to/layers.json afb-daemon --ldpaths=/path/to/winman-binding/
JSON Configurations
---------- ----- -- - -
-ids.json: This file configures a mapping of surface id to some layer id. Also
- In this configuration are information on the actual drawing rectangles
- that applications need to use on a particular layer.
-layout.json: A layout spcification. It is as of yet mostly unused and if not
- parsed correctly should not interfere with window manager operation.
+layers.json: Layers and layout description. In order for the window manager to
+ work, this file needs to be available and passed to the window manager
+ using the environment variable LAYERS_JSON. An *example* layers.json is
+ provided.