Fix line feed code README.md
[AGL/meta-agl.git] / README.md
1 meta-agl, the Yocto layer for Automotive Grade Linux Distribution
2 =================================================================
3
4 This layer's purpose is ... [TBD]
5
6 Layer Dependencies
7 ------------------
8
9 URI: git://git.yoctoproject.org/poky
10 > branch:   dizzy
11 > revision: 5f0d25152bac2d3798663a4ebfdd2df24060f153
12
13 URI: git://git.openembedded.org/meta-openembedded
14 > layer:    meta-oe
15 > branch:   dizzy
16 > revision: 853dcfa0d618dc26bd27b3a1b49494b98d6eee97
17
18 Layers
19 ------
20
21 There are 2 sub-layers in top-level `meta-agl`.
22
23 `meta-agl` is a layer which contains AGL common and middleware packages.
24 > meta-agl/meta-agl
25   
26 `meta-agl-bsp` is a layer which contains required packages to boot AGL distribution on an emulated machine(QEMU).
27 > meta-agl/meta-agl-bsp
28
29 Packagegroups
30 -------------
31
32 AGL package group design:
33
34 These are the top-level packagegroups for AGL Distribution.
35 > packagegroup-agl-core  (basic/common packages out of oe-core)
36 > packagegroup-agl-ivi   (middlewares for AGL IVI)
37
38 Each package group can contain sub-package groups like these.
39 > packagegroup-agl-core-multimedia
40 > packagegroup-agl-core-connectivity
41 > ...
42 > packagegroup-agl-ivi-multimedia
43 > packagegroup-agl-ivi-connectivity
44 > ...
45
46 The recipe for `packagegroup-agl-core-*.bb` will contain common packages between meta-agl, meta-ivi and meta-tizen.
47 > directory: meta-agl/meta-agl/recipes-core/packagegroups
48 > recipes  : packagegroup-agl-core-[subsystem].bb
49
50 The "packagegroups-agl-ivi-*" will contain AGL specific middleware packages.
51 > directory: meta-agl/meta-agl/recipes-ivi/packagegroups
52 > recipes  : packagegroup-agl-ivi-[subsystem].bb
53
54 Supported Machine
55 -----------------
56
57 * QEMU (x86-64) - emulated machine: qemux86-64
58
59 Supported Target of bitbake
60 ------------------------
61
62 * `agl-image-ivi` The baseline image of AGL Distributions
63
64 * `agl-image-minimal` For internal use to develop distribution (experimental)
65 * `agl-image-weston`  For internal use to develop distribution (experimental)
66
67 Build a QEMU image
68 ------------------
69
70 You can build a QEMU image using the following steps:
71
72 1. Export TEMPLATECONF to pick up correct configuration for the build
73    > $ export TEMPLATECONF=/full/path/to/meta-agl/meta-agl/conf
74
75 2. Rune the following command:
76    > $ source poky/oe-init-build-env
77
78 3. Build the minimal image of AGL Distribution
79    > $ bitbake agl-image-ivi
80
81 4. Run the emulator
82    > $ PATH_TO_POKY/poky/scripts/runqemu agl-image-ivi qemux86-64
83
84    For large screen:
85    > $ PATH_TO_POKY/poky/scripts/runqemu agl-image-ivi qemux86-64 bootparams="uvesafb.mode=1280x720-32"
86
87 5. Some weston samples are available from weston terminal.