Mini-manual of `meta-agl`

The mini-manual is added which describes brief explanation of layers
and how to build and run on QEMU.

For more information, see README.md

Signed-off-by: Tadao Tanikawa <tanikawa.tadao@jp.panasonic.com>

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..66acddd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,87 @@
+meta-agl, the Yocto layer for Automotive Grade Linux Distribution\r
+=================================================================\r
+\r
+This layer's purpose is ... [TBD]\r
+\r
+Layer Dependencies\r
+------------------\r
+\r
+URI: git://git.yoctoproject.org/poky\r
+> branch:   dizzy\r
+> revision: 5f0d25152bac2d3798663a4ebfdd2df24060f153\r
+\r
+URI: git://git.openembedded.org/meta-openembedded\r
+> layer:    meta-oe\r
+> branch:   dizzy\r
+> revision: 853dcfa0d618dc26bd27b3a1b49494b98d6eee97\r
+\r
+Layers\r
+------\r
+\r
+There are 2 sub-layers in top-level `meta-agl`.\r
+\r
+`meta-agl` is a layer which contains AGL common and middleware packages.\r
+> meta-agl/meta-agl\r
+  \r
+`meta-agl-bsp` is a layer which contains required packages to boot AGL distribution on an emulated machine(QEMU).\r
+> meta-agl/meta-agl-bsp\r
+\r
+Packagegroups\r
+-------------\r
+\r
+AGL package group design:\r
+\r
+These are the top-level packagegroups for AGL Distribution.\r
+> packagegroup-agl-core  (basic/common packages out of oe-core)\r
+> packagegroup-agl-ivi   (middlewares for AGL IVI)\r
+\r
+Each package group can contain sub-package groups like these.\r
+> packagegroup-agl-core-multimedia\r
+> packagegroup-agl-core-connectivity\r
+> ...\r
+> packagegroup-agl-ivi-multimedia\r
+> packagegroup-agl-ivi-connectivity\r
+> ...\r
+\r
+The recipe for `packagegroup-agl-core-*.bb` will contain common packages between meta-agl, meta-ivi and meta-tizen.\r
+> directory: meta-agl/meta-agl/recipes-core/packagegroups\r
+> recipes  : packagegroup-agl-core-[subsystem].bb\r
+\r
+The "packagegroups-agl-ivi-*" will contain AGL specific middleware packages.\r
+> directory: meta-agl/meta-agl/recipes-ivi/packagegroups\r
+> recipes  : packagegroup-agl-ivi-[subsystem].bb\r
+\r
+Supported Machine\r
+-----------------\r
+\r
+* QEMU (x86-64) - emulated machine: qemux86-64\r
+\r
+Supported Target of bitbake\r
+------------------------\r
+\r
+* `agl-image-ivi` The baseline image of AGL Distributions\r
+\r
+* `agl-image-minimal` For internal use to develop distribution (experimental)\r
+* `agl-image-weston`  For internal use to develop distribution (experimental)\r
+\r
+Build a QEMU image\r
+------------------\r
+\r
+You can build a QEMU image using the following steps:\r
+\r
+1. Export TEMPLATECONF to pick up correct configuration for the build\r
+   > $ export TEMPLATECONF=/full/path/to/meta-agl/meta-agl/conf\r
+\r
+2. Rune the following command:\r
+   > $ source poky/oe-init-build-env\r
+\r
+3. Build the minimal image of AGL Distribution\r
+   > $ bitbake agl-image-ivi\r
+\r
+4. Run the emulator\r
+   > $ PATH_TO_POKY/poky/scripts/runqemu agl-image-ivi qemux86-64\r
+\r
+   For large screen:\r
+   > $ PATH_TO_POKY/poky/scripts/runqemu agl-image-ivi qemux86-64 bootparams="uvesafb.mode=1280x720-32"\r
+\r
+5. Some weston samples are available from weston terminal.\r