From 0882cd30309260ee9e0fe7abcf7d8730ebe79e0e Mon Sep 17 00:00:00 2001 From: Daniel Moore <9156191+drmrd@users.noreply.github.com> Date: Mon, 16 Sep 2024 11:07:11 -0400 Subject: [PATCH] Clarify the scope of the Yocto guide Signed-off-by: Daniel Moore <9156191+drmrd@users.noreply.github.com> --- docs/tutorials/how_to_yocto/index.rst | 37 +++++++++++++++++++-------- 1 file changed, 26 insertions(+), 11 deletions(-) diff --git a/docs/tutorials/how_to_yocto/index.rst b/docs/tutorials/how_to_yocto/index.rst index d9bd1a2c..c59f6b74 100644 --- a/docs/tutorials/how_to_yocto/index.rst +++ b/docs/tutorials/how_to_yocto/index.rst @@ -2,19 +2,34 @@ Notes on Yocto ============== -Steps to building EVerest in a Yocto image -========================================== -#. Set up a Yocto development environment. +Summary +======= + +The EVerest project provides a Yocto layer called ```meta-everest`` +`__ to simplify the incorporation of +EVerest into embedded Linux distributions. This guide provides an overview of +how to incorporate this layer into a basic Linux distribution. + +.. IMPORTANT:: + This guide assumes the reader is familiar with the Yocto Project and its + usage. Setting up a Yocto development environment, an introduction to core + Yocto concepts, BitBake usage, etc. are all outside the scope of this + tutorial. - - The `Yocto Project Quick - Build `__ - guide is an excellent place to start. + If you are new to Yocto, the `Yocto Project's documentation + `__ is an excellent place to start. + + +Steps to building EVerest in a Yocto image +========================================== -#. Proceed with your usual Yocto development setup process, deciding on an - image, BSP, and other layers suitable for your hardware. +#. Proceed with your usual Yocto development setup process, deciding on a base + distribution, BSP, and other layers suitable for your hardware and + requirements. - - We will be using ``core-image-base`` for our examples. + In this tutorial, we will be using the Poky reference distribution and + ``core-image-full-cmdline`` for our examples. #. Download a version of the ``meta-everest`` layer @@ -33,8 +48,8 @@ Steps to building EVerest in a Yocto image #. Add ``meta-everest`` to your build. This is typically done either by manually editing the ``conf/bblayers.conf`` or using the ``bitbake-layers add-layer path/to/layer`` command. As always, refer - to the `Yocto - documentation `__ + to the `Yocto documentation + `__ for more details. #. Configure EVerest in a custom layer The ``meta-everest`` layer does