intro.rst 3.1 KB

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