diff options
Diffstat (limited to 'documentation/dev-manual/dev-manual-intro.rst')
-rw-r--r-- | documentation/dev-manual/dev-manual-intro.rst | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/documentation/dev-manual/dev-manual-intro.rst b/documentation/dev-manual/dev-manual-intro.rst new file mode 100644 index 0000000000..5b26d9eb18 --- /dev/null +++ b/documentation/dev-manual/dev-manual-intro.rst | |||
@@ -0,0 +1,62 @@ | |||
1 | ****************************************** | ||
2 | The Yocto Project Development Tasks Manual | ||
3 | ****************************************** | ||
4 | |||
5 | .. _dev-welcome: | ||
6 | |||
7 | Welcome | ||
8 | ======= | ||
9 | |||
10 | Welcome to the Yocto Project Development Tasks Manual! This manual | ||
11 | provides relevant procedures necessary for developing in the Yocto | ||
12 | Project environment (i.e. developing embedded Linux images and | ||
13 | user-space applications that run on targeted devices). The manual groups | ||
14 | related procedures into higher-level sections. Procedures can consist of | ||
15 | high-level steps or low-level steps depending on the topic. | ||
16 | |||
17 | This manual provides the following: | ||
18 | |||
19 | - Procedures that help you get going with the Yocto Project. For | ||
20 | example, procedures that show you how to set up a build host and work | ||
21 | with the Yocto Project source repositories. | ||
22 | |||
23 | - Procedures that show you how to submit changes to the Yocto Project. | ||
24 | Changes can be improvements, new features, or bug fixes. | ||
25 | |||
26 | - Procedures related to "everyday" tasks you perform while developing | ||
27 | images and applications using the Yocto Project. For example, | ||
28 | procedures to create a layer, customize an image, write a new recipe, | ||
29 | and so forth. | ||
30 | |||
31 | This manual does not provide the following: | ||
32 | |||
33 | - Redundant Step-by-step Instructions: For example, the `Yocto Project | ||
34 | Application Development and the Extensible Software Development Kit | ||
35 | (eSDK) <&YOCTO_DOCS_SDK_URL;>`__ manual contains detailed | ||
36 | instructions on how to install an SDK, which is used to develop | ||
37 | applications for target hardware. | ||
38 | |||
39 | - Reference or Conceptual Material: This type of material resides in an | ||
40 | appropriate reference manual. For example, system variables are | ||
41 | documented in the `Yocto Project Reference | ||
42 | Manual <&YOCTO_DOCS_REF_URL;>`__. | ||
43 | |||
44 | - Detailed Public Information Not Specific to the Yocto Project: For | ||
45 | example, exhaustive information on how to use the Source Control | ||
46 | Manager Git is better covered with Internet searches and official Git | ||
47 | Documentation than through the Yocto Project documentation. | ||
48 | |||
49 | Other Information | ||
50 | ================= | ||
51 | |||
52 | Because this manual presents information for many different topics, | ||
53 | supplemental information is recommended for full comprehension. For | ||
54 | introductory information on the Yocto Project, see the `Yocto Project | ||
55 | Website <&YOCTO_HOME_URL;>`__. If you want to build an image with no | ||
56 | knowledge of Yocto Project as a way of quickly testing it out, see the | ||
57 | `Yocto Project Quick Build <&YOCTO_DOCS_BRIEF_URL;>`__ document. | ||
58 | |||
59 | For a comprehensive list of links and other documentation, see the | ||
60 | "`Links and Related | ||
61 | Documentation <&YOCTO_DOCS_REF_URL;#resources-links-and-related-documentation>`__" | ||
62 | section in the Yocto Project Reference Manual. | ||