Merge changes I02f0a93b,I30b116be

[AGL/meta-agl-devel.git] / README.md

diff --git a/README.md b/README.md
index e8d4699..63bd9fc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,42 +1,66 @@
-?README.md: The OEM needs library for AGL
+meta-agl-devel layer
 ======================================================
 
-There are some software package that the OEM needs, but not exist in the AGL source.
-This layer is add OEM needs library for AGL.
+The meta-agl-devel layer is intended to contain components that are under
+testing/development or software packages that OEMs need but to not exist
+in AGL.
+
+Here below you can find more information about the components of this layer.
+
+Virtualization support (meta-egvirt)
+======================================================
+
+meta-egvirt is the Virtualization Expert Group (EG-VIRT) layer, targeting to enable
+virtualization support in AGL.
+
+For more information, see the README.md file included in the layer, or alternatively
+visit the EG\_VIRT wiki page at: https://wiki.automotivelinux.org/eg-virt
+
+The OEM needs library for AGL
+======================================================
+
+There are some software package that the OEM needs, but not exist in the AGL source.  
+This layer is add OEM needs library for AGL.  
 
 The software packages list:
-    boost
-    fixesproto
-    imagemagick
-    iptables
-    Xorg-macros
-    zlib
-    eglibc = glibc
-    libcurl
-    libgif
-    libneon
-    mongoose
-    fuse
-    protocol buffers
-    bsdiff
-    module-init-tools
-    libcroco
-    libtiff
-    librsvg
-    libpcap
+ * boost
+ * fixesproto
+ * imagemagick
+ * iptables
+ * Xorg-macros
+ * zlib
+ * eglibc = glibc
+ * libcurl
+ * libgif
+ * libneon
+ * mongoose
+ * fuse
+ * protocol buffers
+ * bsdiff
+ * module-init-tools
+ * libcroco
+ * libtiff
+ * librsvg
+ * libpcap
 
 Quick start guide
 -----------------
 To Add these library by add the feature 'agl-oem-extra-libs'
 
 1. Before build you need prepare agl layers:
-   You can read it at meta-agl/README-AGL.md
+ * You can read it at meta-agl/README-AGL.md
 
 2. build the agl-demo-platform with 'agl-oem-extra-libs':
-     >      $ source meta-agl/scripts/aglsetup.sh -m porter agl-demo [agl-appfw-smack] [agl-devel] [agl-netboot] agl-oem-extra-libs
+
+```bash
+source meta-agl/scripts/aglsetup.sh -m qemux86-64 agl-demo [agl-appfw-smack] [agl-devel] [agl-netboot] agl-oem-extra-libs
+```
 
 3. Build agl-demo-platform
-     >      $ bitbake agl-demo-platform
+
+```bash
+bitbake agl-demo-platform
+```
 
 Supported Machines
 ------------------
@@ -46,3 +70,18 @@ Reference hardware:
 * QEMU (x86-64) - emulated machine: qemux86-64
 * Renesas R-Car Gen2 (R-Car M2) - machine: porter
 
+HMI Framework
+======================================================
+Quick start guide
+-----------------
+To Add HMI Framework, it is necessary to add 'hmi-framework' at source command as same as agl-oem-extra-libs
+
+1. Before build you need prepare agl layers:
+ * You can read it at meta-agl/README-AGL.md
+
+2. build the agl-demo-platform with 'hmi-framework':
+
+```bash
+source meta-agl/scripts/aglsetup.sh -m m3ulcb agl-demo [agl-appfw-smack] [agl-devel] [agl-netboot] hmi-framework
+```
+