|author||Richard Purdie <email@example.com>||2017-09-14 12:00:35 +0100|
|committer||Richard Purdie <firstname.lastname@example.org>||2017-09-14 13:36:22 +0100|
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 <email@example.com>
Diffstat (limited to 'meta-poky/README.poky')
1 files changed, 58 insertions, 0 deletions
diff --git a/meta-poky/README.poky b/meta-poky/README.poky
new file mode 100644
@@ -0,0 +1,58 @@
+Poky is an integration of various components to form a complete prepackaged
+build system and development environment. It features support for building
+customised embedded device style images. There are reference demo images
+featuring a X11/Matchbox/GTK themed UI called Sato. The system supports
+cross-architecture application development using QEMU emulation and a
+standalone toolchain and SDK with IDE integration.
+Additional information on the specifics of hardware that Poky supports
+is available in README.hardware. Further hardware support can easily be added
+in the form of layers which extend the systems capabilities in a modular way.
+As an integration layer Poky consists of several upstream projects such as
+BitBake, OpenEmbedded-Core, Yocto documentation and various sources of information
+e.g. for the hardware support. Poky is in turn a component of the Yocto Project.
+The Yocto Project has extensive documentation about the system including a
+reference manual which can be found at:
+OpenEmbedded-Core is a layer containing the core metadata for current versions
+of OpenEmbedded. It is distro-less (can build a functional image with
+DISTRO = "nodistro") and contains only emulated machine support.
+For information about OpenEmbedded, see the OpenEmbedded website:
+Where to Send Patches
+As Poky is an integration repository (built using a tool called combo-layer),
+patches against the various components should be sent to their respective
+ Git repository: http://git.openembedded.org/bitbake/
+ Mailing list: firstname.lastname@example.org
+ Git repository: http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/
+ Mailing list: email@example.com
+ Git repository: http://git.yoctoproject.org/cgit/cgit.cgi/meta-yocto(-bsp)
+ Mailing list: firstname.lastname@example.org
+Everything else should be sent to the OpenEmbedded Core mailing list. If in
+doubt, check the oe-core git repository for the content you intend to modify.
+Before sending, be sure the patches apply cleanly to the current oe-core git
+ Git repository: http://git.openembedded.org/openembedded-core/
+ Mailing list: email@example.com
+Note: The scripts directory should be treated with extra care as it is a mix of
+oe-core and poky-specific files from meta-poky.