Skip to content

Clarify the scope of the Yocto guide #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
drmrd wants to merge 1 commit into
base: feature/yocto-integration-guide
Choose a base branch
from
Open

Clarify the scope of the Yocto guide #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 26 additions & 11 deletions docs/tutorials/how_to_yocto/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``
<https://github.com/EVerest/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 <https://docs.yoctoproject.org/brief-yoctoprojectqs/index.html>`__
guide is an excellent place to start.
If you are new to Yocto, the `Yocto Project's documentation
<https://docs.yoctoproject.org/index.html>`__ 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

Expand All @@ -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 <https://docs.yoctoproject.org/4.0.17/dev-manual/layers.html>`__
to the `Yocto documentation
<https://docs.yoctoproject.org/4.0.17/dev-manual/layers.html>`__
for more details.

#. Configure EVerest in a custom layer The ``meta-everest`` layer does
Expand Down