summaryrefslogtreecommitdiffstats
path: root/meta-poky/README.poky.md
diff options
context:
space:
mode:
authorRichard Purdie <richard.purdie@linuxfoundation.org>2021-06-16 16:32:56 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-06-16 16:33:18 +0100
commit0764538eb7dfab3e6bc60c30105fb4f83aa96ec3 (patch)
treec05220ecfb22979e4e3fefdec9d8e200d705d592 /meta-poky/README.poky.md
parentff6b8af378747d3cd14163d55f836446f0265b16 (diff)
downloadpoky-0764538eb7dfab3e6bc60c30105fb4f83aa96ec3.tar.gz
README: Move to using markdown as the format
(From meta-yocto rev: d397ed754c04b8ef02b01ae4b439610ede12d9d9) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'meta-poky/README.poky.md')
-rw-r--r--meta-poky/README.poky.md71
1 files changed, 71 insertions, 0 deletions
diff --git a/meta-poky/README.poky.md b/meta-poky/README.poky.md
new file mode 100644
index 0000000000..2ba3b5c03e
--- /dev/null
+++ b/meta-poky/README.poky.md
@@ -0,0 +1,71 @@
1Poky
2====
3
4Poky is an integration of various components to form a complete prepackaged
5build system and development environment. It features support for building
6customised embedded device style images. There are reference demo images
7featuring a X11/Matchbox/GTK themed UI called Sato. The system supports
8cross-architecture application development using QEMU emulation and a
9standalone toolchain and SDK with IDE integration.
10
11Additional information on the specifics of hardware that Poky supports
12is available in README.hardware. Further hardware support can easily be added
13in the form of layers which extend the systems capabilities in a modular way.
14
15As an integration layer Poky consists of several upstream projects such as
16BitBake, OpenEmbedded-Core, Yocto documentation and various sources of information
17e.g. for the hardware support. Poky is in turn a component of the Yocto Project.
18
19The Yocto Project has extensive documentation about the system including a
20reference manual which can be found at:
21 http://yoctoproject.org/documentation
22
23OpenEmbedded-Core is a layer containing the core metadata for current versions
24of OpenEmbedded. It is distro-less (can build a functional image with
25DISTRO = "nodistro") and contains only emulated machine support.
26
27For information about OpenEmbedded, see the OpenEmbedded website:
28 http://www.openembedded.org/
29
30
31Contribution Guidelines
32=======================
33
34A guide to submitting patches to OpenEmbedded is available at:
35
36http://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded
37
38There is good documentation on how to write/format patches at:
39
40https://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines
41
42
43Where to Send Patches
44=====================
45
46As Poky is an integration repository (built using a tool called combo-layer),
47patches against the various components should be sent to their respective
48upstreams:
49
50bitbake:
51 Git repository: http://git.openembedded.org/bitbake/
52 Mailing list: bitbake-devel@lists.openembedded.org
53
54documentation:
55 Git repository: http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/
56 Mailing list: docs@lists.yoctoproject.org
57
58meta-poky, meta-yocto-bsp:
59 Git repository: http://git.yoctoproject.org/cgit/cgit.cgi/meta-yocto(-bsp)
60 Mailing list: poky@lists.yoctoproject.org
61
62Everything else should be sent to the OpenEmbedded Core mailing list. If in
63doubt, check the oe-core git repository for the content you intend to modify.
64Before sending, be sure the patches apply cleanly to the current oe-core git
65repository.
66
67 Git repository: http://git.openembedded.org/openembedded-core/
68 Mailing list: openembedded-core@lists.openembedded.org
69
70Note: The scripts directory should be treated with extra care as it is a mix of
71oe-core and poky-specific files from meta-poky.