Add gitlab issue/merge request templates
[AGL/meta-agl-cluster-demo.git] / README.md
1 **README.md for the 'meta-agl-cluster-demo' layer.**
2
3 **See README-AGL.md in meta-agl for general information about Automotive Grade Linux.**
4
5
6 meta-agl-cluster-demo, the layer for the Instrument Cluster DEMO platform of Automotive Grade Linux
7 =================================================================================
8
9 The layer 'meta-agl-cluster-demo' provides a reference/demo platform and
10 applications 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     [agl-dev-community](https://lists.automotivelinux.org/g/agl-dev-community)
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 in meta-agl
33
34
35 Layer Dependencies
36 ------------------
37
38 * Base dependencies [agl-cluster-demo]:
39
40 URI: git://git.yoctoproject.org/poky
41
42 URI: https://gerrit.automotivelinux.org/gerrit/AGL/meta-agl
43
44 URI: https://gerrit.automotivelinux.org/gerrit/AGL/meta-agl-devel
45
46 URI: git://git.openembedded.org/meta-openembedded
47
48 Specifically out of meta-openembedded these sub-layers are used:
49
50  - meta-openembedded/meta-oe
51  - meta-openembedded/meta-multimedia
52  -  meta-openembedded/meta-efl
53  -  meta-openembedded/meta-networking
54  -  meta-openembedded/meta-python
55  -  meta-openembedded/meta-ruby
56
57 URI: https://github.com/meta-qt5/meta-qt5.git
58
59 * Hardware dependencies:
60
61 The Minnowboard Turbot board depends in addition on:
62
63 URI: http://git.yoctoproject.org/meta-intel
64
65
66 Packagegroups
67 -------------
68
69 AGL Cluster Demo Platform's package group design:
70
71 * packagegroup-agl-cluster-demo-platform
72
73 This is for generating the image 'agl-cluster-demo-platform' which is a full
74 image for the Instrument Cluster profile of the AGL distro.
75
76 Following meta-agl's design of packagegroups, ``agl-cluster-demo-platform.bb``
77 contains only ``packagegroup-agl-cluster-demo-platform``.
78
79 ``packagegroup-agl-cluster-demo-platform`` has one packagegroup in it,
80 ``packagegroup-agl-profile-cluster-qt5``, and the packages required for the DEMO
81 applications.
82
83 * packagegroup-agl-cluster-demo-qtcompositor
84
85 This is for generating the image 'agl-cluster-demo-qtcompositor'.
86
87 Supported Machines
88 ------------------
89
90 At the moment only the Minnowboard Turbot has been tested, but the other
91 AGL supported platforms (see `README-AGL.md` in meta-agl layer), should be
92 possible to make work by modifying the gstreamer pipeline used in the
93 agl-cluster-demo-receiver application to replace the use of vaapisink with
94 an alternative that works for the platform.
95
96 Supported Target of bitbake
97 ------------------------
98
99 * `agl-cluster-demo-platform` is the full image of the AGL Instrument Cluster
100 Demo Platform with all applications
101
102 * `agl-cluster-demo-qtcompositor` is the image of the AGL Instrument Cluster
103 Demo that uses qtwayland compositor, contains a simple cluster graphic user
104 interface and some AGL services.