intro.rst 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. .. SPDX-License-Identifier: CC-BY-SA-2.0-UK
  2. ******************************************
  3. The Yocto Project Development Tasks Manual
  4. ******************************************
  5. Welcome
  6. =======
  7. Welcome to the Yocto Project Development Tasks Manual. This manual
  8. provides relevant procedures necessary for developing in the Yocto
  9. Project environment (i.e. developing embedded Linux images and
  10. user-space applications that run on targeted devices). This manual groups
  11. related procedures into higher-level sections. Procedures can consist of
  12. high-level steps or low-level steps depending on the topic.
  13. This manual provides the following:
  14. - Procedures that help you get going with the Yocto Project; for
  15. example, procedures that show you how to set up a build host and work
  16. with the Yocto Project source repositories.
  17. - Procedures that show you how to submit changes to the Yocto Project.
  18. Changes can be improvements, new features, or bug fixes.
  19. - Procedures related to "everyday" tasks you perform while developing
  20. images and applications using the Yocto Project, such as
  21. creating a new layer, customizing an image, writing a new recipe,
  22. and so forth.
  23. This manual does not provide the following:
  24. - Redundant step-by-step instructions: For example, the
  25. :doc:`/sdk-manual/index` manual contains detailed
  26. instructions on how to install an SDK, which is used to develop
  27. applications for target hardware.
  28. - Reference or conceptual material: This type of material resides in an
  29. appropriate reference manual. As an example, system variables are
  30. documented in the :doc:`/ref-manual/index`.
  31. - Detailed public information not specific to the Yocto Project: For
  32. example, exhaustive information on how to use the Git version
  33. control system is better covered with Internet searches and official Git
  34. documentation than through the Yocto Project documentation.
  35. Other Information
  36. =================
  37. Because this manual presents information for many different topics,
  38. supplemental information is recommended for full comprehension. For
  39. introductory information on the Yocto Project, see the
  40. :yocto_home:`Yocto Project Website <>`. If you want to build an image with no
  41. knowledge of Yocto Project as a way of quickly testing it out, see the
  42. :doc:`/brief-yoctoprojectqs/index` document.
  43. For a comprehensive list of links and other documentation, see the
  44. ":ref:`ref-manual/resources:links and related documentation`"
  45. section in the Yocto Project Reference Manual.