summaryrefslogtreecommitdiffstats
path: root/meta-poky/README.poky
diff options
context:
space:
mode:
authorRichard Purdie <richard.purdie@linuxfoundation.org>2017-09-14 12:00:35 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-09-14 13:36:22 +0100
commitabea8ec5063998e0e2b822be7704c0d14569df0e (patch)
treee77ce68754687a179c878a744caf5a71721c955c /meta-poky/README.poky
parent145c245a56ff26f098ced26ee3c5c7bc45b0ead7 (diff)
downloadpoky-abea8ec5063998e0e2b822be7704c0d14569df0e.tar.gz
meta-yocto: Restructure and tidy up READMEs
The YP Compat v2 standard requres a more specific README structure. Bring meta-yocto to the required standard and clean up some of the data in the READMEs whilst in there. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'meta-poky/README.poky')
-rw-r--r--meta-poky/README.poky58
1 files changed, 58 insertions, 0 deletions
diff --git a/meta-poky/README.poky b/meta-poky/README.poky
new file mode 100644
index 0000000000..0a42843186
--- /dev/null
+++ b/meta-poky/README.poky
@@ -0,0 +1,58 @@
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
30Where to Send Patches
31=====================
32
33As Poky is an integration repository (built using a tool called combo-layer),
34patches against the various components should be sent to their respective
35upstreams:
36
37bitbake:
38 Git repository: http://git.openembedded.org/bitbake/
39 Mailing list: bitbake-devel@lists.openembedded.org
40
41documentation:
42 Git repository: http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/
43 Mailing list: yocto@yoctoproject.org
44
45meta-poky, meta-yocto-bsp:
46 Git repository: http://git.yoctoproject.org/cgit/cgit.cgi/meta-yocto(-bsp)
47 Mailing list: poky@yoctoproject.org
48
49Everything else should be sent to the OpenEmbedded Core mailing list. If in
50doubt, check the oe-core git repository for the content you intend to modify.
51Before sending, be sure the patches apply cleanly to the current oe-core git
52repository.
53
54 Git repository: http://git.openembedded.org/openembedded-core/
55 Mailing list: openembedded-core@lists.openembedded.org
56
57Note: The scripts directory should be treated with extra care as it is a mix of
58oe-core and poky-specific files from meta-poky.