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