protozero: fix missing license declaration
[AGL/meta-agl-demo.git] / README.md
1 **README.md for the 'meta-agl-demo' layer.**
2
3 **See README-AGL.md for general information about Automotive Grade Linux.**
4
5
6 meta-agl-demo, the reference UI layer for the DEMO platform of Automotive Grade Linux
7 =================================================================================
8
9 The layer 'meta-agl-demo' provides a reference/demo platform and applications
10 for the AGL Distribution.
11
12 AGL is creating an automotive specific Linux distribution (AGL UCB) that unifies
13 the software that has been written in a number of places already,
14 such as GENIVI and Tizen IVI.
15
16 The AGL community appreciates feedback, ideas, suggestion, bugs and
17 documentation just as much as code. Please join the irc conversation
18 at the #automotive channel on irc.freenode.net and our mailing list.
19
20 For infomation for subscribing to the mailing list
21     [automotive-discussions](http://lists.linuxfoundation.org/mailman/listinfo/automotive-discussions)
22 For information about AGL Distribution, see the
23     [AGL Distribution](https://wiki.automotivelinux.org/agl-distro)
24 For information abount Getting started with AGL
25     [here](https://wiki.automotivelinux.org/start/getting-started)
26 For information about contributing to the AGL Distro
27     [here](https://wiki.automotivelinux.org/agl-distro/contributing)
28
29
30 Quick start guide
31 -----------------
32 See README-AGL.md
33
34
35 Layer Dependencies
36 ------------------
37
38 * Base dependencies [agl-demo]:
39
40 URI: git://git.yoctoproject.org/poky
41 > branch         : jethro
42 > tested revision: 40376446904ae3529be41737fed9a0b650ed167d
43
44 URI: https://gerrit.automotivelinux.org/gerrit/AGL/meta-agl
45 > branch:   master
46
47 URI: git://git.openembedded.org/meta-openembedded
48 > layer          : meta-openembedded
49 > branch         : jethro
50 > tested revision: 8ab04afbffb4bc5184cfe0655049de6f44269990
51
52 Specifically out of meta-openembedded these sub-layers are used:
53
54  - meta-openembedded/meta-oe
55  - meta-openembedded/meta-multimedia
56  -  meta-openembedded/meta-efl
57  -  meta-openembedded/meta-networking
58  -  meta-openembedded/meta-python
59  -  meta-openembedded/meta-ruby
60
61 URI: https://github.com/meta-qt5/meta-qt5.git
62 > branch:   jethro (b/c of qt-5.5.x)
63 > tested revision: ea37a0bc987aa9484937ad68f762b4657c198617
64
65 * Hardware dependencies:
66
67 The Renesas R-Car Gen2 (Porter) board depends in addition on:
68
69 URI: https://gerrit.automotivelinux.org/gerrit/AGL/meta-renesas
70 > branch:   agl-1.0-bsp-1.8.0
71 > tested revision: 82611ccadef36ab0b8a6fd6fb1cf055e115f1ef5
72 > (or later)
73
74 * Extra feature dependencies:
75
76  * The feature `agl-appfw-smack` has these dependencies
77                 * `meta-intel-iot-security`
78                 > URI: https://github.com/01org/meta-intel-iot-security
79                 > branch            : jethro
80                 > tested revision: c5906a1553513ef192a58231700357c5f14f4ae4
81
82                 * `meta-agl-extra/meta-app-framework`
83                 > URI: https://gerrit.automotivelinux.org/gerrit/gitweb?p=AGL/meta-agl-extra.git
84                 > branch            : master
85
86  * The feature `agl-sota` has these dependencies:
87                 * `meta-agl-extra/meta-sota`
88                 > URI: https://gerrit.automotivelinux.org/gerrit/gitweb?p=AGL/meta-agl-extra.git
89                 > branch            : master
90
91                 * `meta-openembedded`
92                 > layer          : meta-openembedded
93                 > branch         : jethro
94                 > tested revision: 8ab04afbffb4bc5184cfe0655049de6f44269990
95
96                         * specifically:
97                                 * `meta-openembedded/meta-filesystems`
98                                 * `meta-openembedded/meta-ruby`
99
100
101                 * `meta-rust`
102                 > URI: https://github.com/konsulko/meta-rust
103                 > branch            : jethro
104                 > tested revision: 395cde581938d862abb6a9219c0118c81cf01da2
105
106         * The feature `agl-netboot` has these dependenies:
107                 * `meta-agl/meta-netboot`
108
109                         > URI: https://gerrit.automotivelinux.org/gerrit/gitweb?p=AGL/meta-agl.git
110                         > branch            : master
111
112
113 Packagegroups
114 -------------
115
116 AGL Demo Platform's package group design:
117
118 * packagegroup-agl-demo-platform
119
120 This is for generating the image 'agl-demo-platform' which is a full image
121 for the IVI profile of the AGL distro.
122
123 As meta-agl's design of packagegroups, ``agl-demo-platform.bb`` contains
124 only ``packagegroup-agl-demo-platform`` and the packages of the DEMO applications.
125
126 ``agl-demo-platform`` has 4 packagegroups in it,
127 ``packagegroup-agl-image-minimal``, ``packagegroup-agl-image-ivi``,
128 ``packagegroup-ivi-common-core``, and ``packagegroup-agl-demo-platform``.
129
130 * packagegroup-agl-appfw*
131
132 These packagegroups contains packages for application framework of AGL Distro.
133 Subsystem should maintain ``packagegroup-agl-appfw-[subsystem].bb`` which
134 should hold sufficient packages for application framework of AGL Distro.
135
136 Subsystems also can maintain their own packagegroups under appropriate
137 ``recipes-*/``.
138
139 For example, Qt5 has 2 packagegroups in ``meta-agl-demo``,
140 ``packagegroup-agl-appfw-native-qt5`` and ``packagegroup-agl-demo-qt-examples``
141 which are under ``recipes-qt/``.
142
143 The ``packagegroup-agl-appfw-native-qt5`` is included by
144 ``packagegroup-agl-appfw-native`` because Qt5 belongs to native application
145 framework of AGL Distro.
146
147 The ``packagegroup-agl-demo-qt-examples`` is added to local.conf if needed
148 because they are not mandatory for AGL application framework and AGL Demo
149 Platform.
150
151 Supported Machines
152 ------------------
153
154 See `README-AGL.md` in meta-agl layer.
155
156 Supported Target of bitbake
157 ------------------------
158
159 * `agl-demo-platform` is the full image of the AGL Demo Platform with all applications
160