aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--MAINTAINERS25
-rw-r--r--README.md82
2 files changed, 76 insertions, 31 deletions
diff --git a/MAINTAINERS b/MAINTAINERS
index 373bdd1..eb397ee 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1,21 +1,33 @@
This file contains a list of maintainers for the meta-ivi layer.
Please submit any patches against meta-ivi to the maintainers
-(cc:ing the Yocto Project mailing list (yocto@yoctoproject.org))
+(cc:ing the meta-ivi mailing list (genivi-meta-ivi@lists.genivi.org))
with '[meta-ivi]' in subject
You may also contact the maintainers directly in case you have any questions
on a particular meta-ivi topic, but please try to do the following first:
- - look in the Yocto Project Bugzilla
- (http://bugzilla.yoctoproject.org/) to see if a problem has
- already been reported
+ - look in the meta-ivi Bugzilla
+ (https://bugs.genivi.org/buglist.cgi?product=meta-ivi) to see if
+ a problem has already been reported
- - look through recent entries of the Yocto mailing list archives
- (https://lists.yoctoproject.org/pipermail/yocto/) to see if other
+ - look through recent entries of the meta-ivi mailing list archives
+ (http://lists.genivi.org/pipermail/genivi-meta-ivi/) to see if other
people have run into similar problems or had similar questions
answered.
+When creating patches, please use something like:
+> git format-patch -s --subject-prefix='meta-ivi][PATCH' origin
+
+When sending patches, please use something like:
+> git send-email --to=florin.sarbu@windriver.com --to=holger@windriver.com \
+> --cc=genivi-meta-ivi@lists.genivi.org <generated patch>
+
+Please refer to:
+https://wiki.yoctoproject.org/wiki/Contribution_Guidelines#General_Information
+for some useful guidelines to be followed when submitting patches.
+
+
Descriptions of section entries:
M: Mail patches to: FullName <address@domain>
@@ -35,3 +47,4 @@ F: *
M: Florin Sarbu <florin.sarbu@windriver.com>
F: /
+
diff --git a/README.md b/README.md
index b2c84f9..4a3e276 100644
--- a/README.md
+++ b/README.md
@@ -2,64 +2,96 @@ meta-ivi, the Yocto layer for In-Vehicle Infotainment
=====================================================
This layer's purpose is to add In-Vehicle Infotainment (IVI) support when
-used with Poky. The goal is to be able to build a GENIVI compliant baseline
-image.
+used with Poky. The goal is to make the Yocto Project reference system
+Poky GENIVI compliant.
-Please see the MAINTAINERS file for information on contacting the maintainers
+Please see the
+[MAINTAINERS](http://git.yoctoproject.org/cgit/cgit.cgi/meta-ivi/tree/MAINTAINERS)
+file for information on contacting the maintainers
of this layer, as well as instructions for submitting patches.
-You may in addition influence future meta-ivi development. For that take a
-look at the [meta-ivi Trello board](https://trello.com/b/HplBZa2l) and vote.
+The meta-ivi project welcomes contributions. You can contribute code,
+submit patches, report bugs, answer questions on our mailing lists and
+review and edit our documentation and much more.
+
+Subscribe to the mailing list
+ [here](https://lists.genivi.org/mailman/listinfo/genivi-meta-ivi)
+View or Report bugs
+ [here](https://bugs.genivi.org/buglist.cgi?product=meta-ivi).
+Read or Edit the wiki
+ [here](http://wiki.projects.genivi.org/index.php/meta-ivi).
+Vote or Comment on our plan
+ [here](https://trello.com/b/HplBZa2l/meta-ivi-development).
+For information about the Yocto Project, see the
+ [Yocto Project website](https://www.yoctoproject.org).
+For information about the Yocto GENIVI Baseline, see the
+ [Yocto GENIVI Baseline website](https://www.yoctoproject.org).
Layer Dependencies
------------------
-URI: git://git.yoctoproject.org/poky
-branch: master
-revision: d823759b4594143d522eae0b2a2498436a6dcb1e
+URI: git://git.yoctoproject.org/poky
+> branch: master
+> revision: 9de0ad47462c13ac4a2d73e12e92be6c1b4e0415
Using the above git sha's and master meta-ivi, bitbaking foton-image is
known to work (the foton-image build should be GENIVI 4.0 compliant).
-For creating specific GENIVI compliant images, please make sure you git
-checkout on the desired meta-ivi branch and follow the build instructions
-located in the README.md file.
+For creating a specific GENIVI compliant image version, please make sure you
+git checkout the related meta-ivi branch and follow the build instructions
+located in the README.md file of that branch. So for example, to build
+an image that should be GENIVI 3.0 compliant, checkout the meta-ivi 3.0 branch,
+and follow the README.md part of that branch. As does the GENIVI Alliance
+we only support the current and the previous version. Any version older
+than that is not supported any more, and therefore may not build or run.
-Build a QEMU image including GENIVI P1 components
+Supported Machines
+------------------
+
+We do smoke test the builds of the three machines that we currently support:
+
+* QEMU (ARMv7) - emulated machine: vexpressa9
+* QEMU (IA-32) - emulated machine: qemux86
+* QEMU (x86-64) - emulated machine: qemux86-64
+
+Please check on our [wiki](http://wiki.projects.genivi.org/index.php/meta-ivi)
+regarding any community supported machines.
+For example there Renesas provides a public Board Support Package (BSP)
+available for use with meta-ivi.
+
+Build a QEMU image that contains GENIVI components
--------------------------------------------------
-You can build a QEMU image including GENIVI P1 components using the
+You can build a QEMU image that should be GENIVI compliant using the
following steps:
1. Run the following command:
-
> $ source poky/oe-init-build-env
-2. Add meta-ivi path to COREBASE/build/conf/bblayers.conf BBLAYERS variable.
+2. Add meta-ivi path to $BUILDDIR/conf/bblayers.conf BBLAYERS variable.
3. Set MACHINE ??= "vexpressa9", MACHINE ??= "qemux86" or MACHINE ??= "qemux86-64"
-in COREBASE/build/conf/local.conf file to build for an emulated ARMv7a, x86 or x86-64
+in $BUILDDIR/conf/local.conf file to build for an emulated ARMv7a, x86 or x86-64
instruction-set maschine respectively.
-4. Add INCOMPATIBLE_LICENSE = "GPLv3" in COREBASE/build/conf/local.conf file.
+4. Add INCOMPATIBLE_LICENSE = "GPLv3" in $BUILDDIR/conf/local.conf file.
-5. Set DISTRO ?= "poky-ivi-systemd" in COREBASE/build/conf/local.conf file.
+5. Set DISTRO ?= "poky-ivi-systemd" in $BUILDDIR/conf/local.conf file.
-6. Optional: In COREBASE/build/conf/local.conf file, you may uncomment
+6. Optional: In $BUILDDIR/conf/local.conf file, you may uncomment
BB_NUMBER_THREADS = "4" and PARALLEL_MAKE = "-j 4" if you build on a
quad-core machine.
-7. Build foton-image including GENIVI 4.0 (Foton) P1 components
-
+7. Build foton-image including GENIVI 4.0 (Foton) components
> $ bitbake foton-image
8. Run the emulator:
-
- > for qemu vexpressa9:
+ > for qemu vexpressa9:
> $ PATH_TO_META_IVI/meta-ivi/scripts/runqemu foton-image vexpressa9
- > for qemu x86:
+ > for qemu x86:
> $ PATH_TO_POKY/poky/scripts/runqemu foton-image qemux86
- > for qemu x86-64:
+ > for qemu x86-64:
> $ PATH_TO_POKY/poky/scripts/runqemu foton-image qemux86-64
+