blob: 8885eb89ffe01bf994234b1750f8e16a0f035951 [file] [log] [blame]
Andrew Geisslerf0343792020-11-18 10:42:21 -06001.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
Andrew Geisslerc9f78652020-09-18 14:11:35 -05002
3**********************************************
4The Yocto Project Overview and Concepts Manual
5**********************************************
6
7.. _overview-manual-welcome:
8
9Welcome
10=======
11
12Welcome to the Yocto Project Overview and Concepts Manual! This manual
13introduces the Yocto Project by providing concepts, software overviews,
14best-known-methods (BKMs), and any other high-level introductory
15information suitable for a new Yocto Project user.
16
17The following list describes what you can get from this manual:
18
19- `Introducing the Yocto Project <#overview-yp>`__\ *:* This chapter
20 provides an introduction to the Yocto Project. You will learn about
21 features and challenges of the Yocto Project, the layer model,
22 components and tools, development methods, the
23 :term:`Poky` reference distribution, the
24 OpenEmbedded build system workflow, and some basic Yocto terms.
25
26- `The Yocto Project Development
27 Environment <#overview-development-environment>`__\ *:* This chapter
28 helps you get started understanding the Yocto Project development
29 environment. You will learn about open source, development hosts,
30 Yocto Project source repositories, workflows using Git and the Yocto
31 Project, a Git primer, and information about licensing.
32
33- :doc:`overview-manual-concepts` *:* This
34 chapter presents various concepts regarding the Yocto Project. You
35 can find conceptual information about components, development,
36 cross-toolchains, and so forth.
37
38This manual does not give you the following:
39
40- *Step-by-step Instructions for Development Tasks:* Instructional
41 procedures reside in other manuals within the Yocto Project
42 documentation set. For example, the :doc:`../dev-manual/dev-manual`
43 provides examples on how to perform
44 various development tasks. As another example, the
45 :doc:`../sdk-manual/sdk-manual` manual contains detailed
46 instructions on how to install an SDK, which is used to develop
47 applications for target hardware.
48
49- *Reference Material:* This type of material resides in an appropriate
50 reference manual. For example, system variables are documented in the
51 :doc:`../ref-manual/ref-manual`. As another
52 example, the :doc:`../bsp-guide/bsp-guide` contains reference information on
53 BSPs.
54
55- *Detailed Public Information Not Specific to the Yocto Project:* For
56 example, exhaustive information on how to use the Source Control
57 Manager Git is better covered with Internet searches and official Git
58 Documentation than through the Yocto Project documentation.
59
60.. _overview-manual-other-information:
61
62Other Information
63=================
64
65Because this manual presents information for many different topics,
66supplemental information is recommended for full comprehension. For
67additional introductory information on the Yocto Project, see the
68:yocto_home:`Yocto Project Website <>`. If you want to build an image
69with no knowledge of Yocto Project as a way of quickly testing it out,
70see the :doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` document.
71For a comprehensive list of links and other documentation, see the
72":ref:`Links and Related
73Documentation <resources-links-and-related-documentation>`"
74section in the Yocto Project Reference Manual.