meta-agl-bsp: extend qemux86-64 hardware support
[AGL/meta-agl.git] / README.md
index 74c0f89..9967f08 100644 (file)
--- a/README.md
+++ b/README.md
-meta-agl, the Yocto layer for Automotive Grade Linux Distribution
-=================================================================
+# 'meta-agl' layer
 
-This layer's purpose is ... [TBD]
+See README-AGL.md for general information about Automotive Grade Linux.
 
-Layer Dependencies
-------------------
+## meta-agl, the core layer for Automotive Grade Linux Distribution
 
-URI: git://git.yoctoproject.org/poky
-> branch:   dizzy
-> revision: 5f0d25152bac2d3798663a4ebfdd2df24060f153
+AGL is creating an automotive specific Linux distribution that unifies
+the software that has been written in a number of places already,
+such as GENIVI and Tizen IVI.
 
-URI: git://git.openembedded.org/meta-openembedded
-> layer:    meta-oe
-> branch:   dizzy
-> revision: 853dcfa0d618dc26bd27b3a1b49494b98d6eee97
+The layer 'meta-agl' provides a minimal set of software
+to boot system of AGL Distribution. 'meta-agl' is the minimal
+core which is used build AGL profiles on top of it.
 
-Layers
-------
+Especially there is no reference UI included which is part of 'meta-agl-demo'.
 
-There are 2 sub-layers in top-level `meta-agl`.
+Additional components like the security framework are part of 'meta-agl-extra'.
 
-`meta-agl` is a layer which contains AGL common and middleware packages.
-> meta-agl/meta-agl
-  
-`meta-agl-bsp` is a layer which contains required packages to boot AGL distribution on an emulated machine(QEMU).
-> meta-agl/meta-agl-bsp
+The AGL community appreciates feedback, ideas, suggestion, bugs and
+documentation just as much as code. Please join the irc conversation
+at the #automotive channel on irc.freenode.net and our mailing list.
 
-Packagegroups
--------------
+For infomation for subscribing to the mailing list
+    [automotive-discussions](http://lists.linuxfoundation.org/mailman/listinfo/automotive-discussions)
+For information about AGL Distribution, see the
+    [AGL Distribution](https://wiki.automotivelinux.org/agl-distro)
+For information abount Getting started with AGL
+    [here](https://wiki.automotivelinux.org/start/getting-started)
+For information about contributing to the AGL Distro
+    [here](https://wiki.automotivelinux.org/agl-distro/contributing)
 
-AGL package group design:
-
-These are the top-level packagegroups for AGL Distribution.
-> packagegroup-agl-core  (basic/common packages out of oe-core)
-> packagegroup-agl-ivi   (middlewares for AGL IVI)
-
-Each package group can contain sub-package groups like these.
-> packagegroup-agl-core-multimedia
-> packagegroup-agl-core-connectivity
-> ...
-> packagegroup-agl-ivi-multimedia
-> packagegroup-agl-ivi-connectivity
-> ...
-
-The recipe for `packagegroup-agl-core-*.bb` will contain common packages between meta-agl, meta-ivi and meta-tizen.
-> directory: meta-agl/meta-agl/recipes-core/packagegroups
-> recipes  : packagegroup-agl-core-[subsystem].bb
+## Quick start guide
 
-The "packagegroups-agl-ivi-*" will contain AGL specific middleware packages.
-> directory: meta-agl/meta-agl/recipes-ivi/packagegroups
-> recipes  : packagegroup-agl-ivi-[subsystem].bb
+See README-AGL.md
 
-Supported Machine
------------------
+## 'meta-agl' Layer Dependencies
 
-* QEMU (x86-64) - emulated machine: qemux86-64
+* poky
+  > URI: git://git.yoctoproject.org/poky
+  > branch         : jethro
+  > tested revision: 40376446904ae3529be41737fed9a0b650ed167d
 
-Supported Target of bitbake
-------------------------
+* meta-openembedded
+  > URI: git://git.openembedded.org/meta-openembedded
+  > layer          : meta-openembedded
+  > branch         : jethro
+  > tested revision: 8ab04afbffb4bc5184cfe0655049de6f44269990
 
-* `agl-image-ivi` The baseline image of AGL Distributions
+Specifically out of meta-openembedded these sub-layers are used:
 
-* `agl-image-minimal` For internal use to develop distribution (experimental)
-* `agl-image-weston`  For internal use to develop distribution (experimental)
+* meta-openembedded/meta-oe
+* meta-openembedded/meta-multimedia
+* meta-openembedded/meta-networking
+* meta-openembedded/meta-python
 
-Build a QEMU image
-------------------
+## Layers
 
-You can build a QEMU image using the following steps:
+There are 5 layers in top-level `meta-agl`.
 
-1. Export TEMPLATECONF to pick up correct configuration for the build
-   > $ export TEMPLATECONF=/full/path/to/meta-agl/meta-agl/conf
+* `meta-agl/meta-ivi-common`\
+  `meta-ivi-common` is a layer which contains common packages to AGL
+  Distribution and other platforms for In-Vehicle Infotainment system.
+* `meta-agl/meta-agl`\
+  `meta-agl` is a layer which contains AGL common and middleware packages.
+* `meta-agl/meta-agl-bsp`\
+  `meta-agl-bsp` is a layer which contains required packages to boot AGL
+  distribution on an emulated machine(QEMU).
+* `meta-agl/meta-netboot`\
+  `meta-netboot` contains the netboot initrd support recipes. This is needed
+  in case of booting over the network as NFS does not support the securitylabels.
 
-2. Rune the following command:
-   > $ source poky/oe-init-build-env
+## Packagegroups
 
-3. Build the minimal image of AGL Distribution
-   > $ bitbake agl-image-ivi
-
-4. Run the emulator
-   > $ PATH_TO_POKY/poky/scripts/runqemu agl-image-ivi qemux86-64
-
-   For large screen:
-   > $ PATH_TO_POKY/poky/scripts/runqemu agl-image-ivi qemux86-64 bootparams="uvesafb.mode_option=1280x720-32"
+AGL package group design:
 
-5. Some weston samples are available from weston terminal.
+* packagegroup-agl-image-minimal
+
+        packagegroup-agl-core-automotive.bb
+        packagegroup-agl-core-connectivity.bb
+        packagegroup-agl-core-graphics.bb
+        packagegroup-agl-core-kernel.bb
+        packagegroup-agl-core-multimedia.bb
+        packagegroup-agl-core-navi-lbs.bb
+        packagegroup-agl-core-os-commonlibs.bb
+        packagegroup-agl-core-security.bb
+        packagegroup-agl-core-speech-services.bb
+
+These are for making image ``agl-image-minimal`` which is small image just
+capable of allowing a device to boot.
+
+Subsystem should maintain packagegroup-agl-core-[subsystem].bb which should
+hold sufficient packages to build ``agl-image-minimal``.
+
+* packagegroup-agl-image-ivi
+
+        packagegroup-agl-ivi-automotive.bb
+        packagegroup-agl-ivi-connectivity.bb
+        packagegroup-agl-ivi-graphics.bb
+        packagegroup-agl-ivi-kernel.bb
+        packagegroup-agl-ivi-multimedia.bb
+        packagegroup-agl-ivi-navi-lbs.bb
+        packagegroup-agl-ivi-os-commonlibs.bb
+        packagegroup-agl-ivi-security.bb
+        packagegroup-agl-ivi-speech-services.bb
+
+These are for making image ``agl-image-ivi`` which is baseline for the profiles
+of AGL distro. 'Baseline' means Service Layer and Operating System Layer defined
+in AGL Spec v1.0.
+
+* packagegroup-agl-test.bb
+
+Additional tools used in QA tests (for agl-image*-qa).
+
+* packagegroup-ivi-common*
+
+        packagegroup-ivi-common-core-automotive.bb
+        packagegroup-ivi-common-core.bb
+        packagegroup-ivi-common-core-connectivity.bb
+        packagegroup-ivi-common-core-graphics.bb
+        packagegroup-ivi-common-core-kernel.bb
+        packagegroup-ivi-common-core-multimedia.bb
+        packagegroup-ivi-common-core-navi-lbs.bb
+        packagegroup-ivi-common-core-os-commonlibs.bb
+        packagegroup-ivi-common-core-security.bb
+        packagegroup-ivi-common-core-speech-services.bb
+        packagegroup-ivi-common-test.bb
+
+These are for picking up some packages from upstreams like GENIVI/Tizen/Others.
+The layer of ``meta-ivi-common`` has no image to build, all packagegroups are
+aggregated to ``packagegroup-ivi-common-core' and it is included by images,
+``agl-image-ivi.bb`` and ``agl-demo-platform.bb``.
+
+## Supported Machines
+
+See [docs.automotivelinux.org](http://docs.automotivelinux.org)