diff options
Diffstat (limited to 'documentation/overview-manual/overview-manual-intro.rst')
-rw-r--r-- | documentation/overview-manual/overview-manual-intro.rst | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/documentation/overview-manual/overview-manual-intro.rst b/documentation/overview-manual/overview-manual-intro.rst new file mode 100644 index 0000000000..82c0051c47 --- /dev/null +++ b/documentation/overview-manual/overview-manual-intro.rst | |||
@@ -0,0 +1,74 @@ | |||
1 | ********************************************** | ||
2 | The Yocto Project Overview and Concepts Manual | ||
3 | ********************************************** | ||
4 | |||
5 | .. _overview-manual-welcome: | ||
6 | |||
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 | `Poky <&YOCTO_DOCS_REF_URL;#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 | |||
31 | - `Yocto Project Concepts <#overview-manual-concepts>`__\ *:* This | ||
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 | ||
40 | documentation set. For example, the `Yocto Project Development Tasks | ||
41 | Manual <&YOCTO_DOCS_DEV_URL;>`__ provides examples on how to perform | ||
42 | various development tasks. As another example, the `Yocto Project | ||
43 | Application Development and the Extensible Software Development Kit | ||
44 | (eSDK) <&YOCTO_DOCS_SDK_URL;>`__ manual contains detailed | ||
45 | instructions on how to install an SDK, which is used to develop | ||
46 | applications for target hardware. | ||
47 | |||
48 | - *Reference Material:* This type of material resides in an appropriate | ||
49 | reference manual. For example, system variables are documented in the | ||
50 | `Yocto Project Reference Manual <&YOCTO_DOCS_REF_URL;>`__. As another | ||
51 | example, the `Yocto Project Board Support Package (BSP) Developer's | ||
52 | Guide <&YOCTO_DOCS_BSP_URL;>`__ 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 | |||
62 | Other Information | ||
63 | ================= | ||
64 | |||
65 | Because this manual presents information for many different topics, | ||
66 | supplemental information is recommended for full comprehension. For | ||
67 | additional introductory information on the Yocto Project, see the `Yocto | ||
68 | Project Website <&YOCTO_HOME_URL;>`__. If you want to build an image | ||
69 | with no knowledge of Yocto Project as a way of quickly testing it out, | ||
70 | see the `Yocto Project Quick Build <&YOCTO_DOCS_BRIEF_URL;>`__ document. | ||
71 | For a comprehensive list of links and other documentation, see the | ||
72 | "`Links and Related | ||
73 | Documentation <&YOCTO_DOCS_REF_URL;#resources-links-and-related-documentation>`__" | ||
74 | section in the Yocto Project Reference Manual. | ||