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