1Poky
2====
3
4Poky is an integration of various components to form a pre-packaged
5build system and development environment which is used as a development and
6validation tool by the [Yocto Project](https://www.yoctoproject.org/). It
7features support for building customised embedded style device images
8and custom containers. There are reference demo images ranging from X11/GTK+
9 to Weston, commandline and more. The system supports cross-architecture
10application development using QEMU emulation and a standalone toolchain and
11SDK suitable for IDE integration.
12
13Additional information on the specifics of hardware that Poky supports
14is available in README.hardware. Further hardware support can easily be added
15in the form of BSP layers which extend the systems capabilities in a modular way.
16Many layers are available and can be found through the
17[layer index](https://layers.openembedded.org/).
18
19As an integration layer Poky consists of several upstream projects such as
20[BitBake](https://git.openembedded.org/bitbake/),
21[OpenEmbedded-Core](https://git.openembedded.org/openembedded-core/),
22[Yocto documentation](https://git.yoctoproject.org/cgit.cgi/yocto-docs/),
23the '[meta-yocto](https://git.yoctoproject.org/cgit.cgi/meta-yocto/)' layer
24which has configuration and hardware support components. These components
25are all part of the Yocto Project and OpenEmbedded ecosystems.
26
27The Yocto Project has extensive documentation about the system including a
28reference manual which can be found at <https://docs.yoctoproject.org/>
29
30OpenEmbedded is the build architecture used by Poky and the Yocto project.
31For information about OpenEmbedded, see the
32[OpenEmbedded website](https://www.openembedded.org/).
33
34Contribution Guidelines
35-----------------------
36
37Please refer to our contributor guide here: https://docs.yoctoproject.org/dev/contributor-guide/
38for full details on how to submit changes.
39
40Where to Send Patches
41---------------------
42
43As Poky is an integration repository (built using a tool called combo-layer),
44patches against the various components should be sent to their respective
45upstreams:
46
47OpenEmbedded-Core (files in meta/, meta-selftest/, meta-skeleton/, scripts/):
48
49- Git repository: <https://git.openembedded.org/openembedded-core/>
50- Mailing list: openembedded-core@lists.openembedded.org
51
52BitBake (files in bitbake/):
53
54- Git repository: <https://git.openembedded.org/bitbake/>
55- Mailing list: bitbake-devel@lists.openembedded.org
56
57Documentation (files in documentation/):
58
59- Git repository: <https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/>
60- Mailing list: docs@lists.yoctoproject.org
61
62meta-yocto (files in meta-poky/, meta-yocto-bsp/):
63
64- Git repository: <https://git.yoctoproject.org/cgit/cgit.cgi/meta-yocto>
65- Mailing list: poky@lists.yoctoproject.org
66
67If in doubt, check the openembedded-core git repository for the content you
68intend to modify as most files are from there unless clearly one of the above
69categories. Before sending, be sure the patches apply cleanly to the current
70git repository branch in question.
71
72[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/765/badge)](https://bestpractices.coreinfrastructure.org/projects/765)
73
74