Cookbook: Difference between revisions

From Yocto Project
Jump to navigationJump to search
(Added 'Appliance How-Tos' section / Startup scripts link)
(Resurrecting the Yocto Project Cookbook examples)
Line 1: Line 1:
This page collects working examples on how to use the Yocto Project. Please test all procedures before adding them to this page.
'''[WORK IN PROGRESS]
'''


== Yocto Project Quick Start Guide ==
This Yocto Project Cookbook collects working examples of how to use the Yocto Project, filling some of the gaps between the
[http://www.yoctoproject.org/docs/current/yocto-project-qs/yocto-project-qs.html Yocto Project Quick Start Guide] and the
[http://www.yoctoproject.org/docs/current/mega-manual/mega-manual.html full reference documentation]. Like any
cookbook, we'll include some basic as well as more complex examples you can follow to learn about the pantry of
components and files available, as well as the techniques for manipulating them using Yocto Project tools.


The official Quick Start Guide contains a step-by-step walkthrough showing how to set up your environment and perform your first build: [http://www.yoctoproject.org/docs/current/yocto-project-qs/yocto-project-qs.html Quick Start Guide]
We encourage you, the Yocto Project community, to add your own examples to this Cookbook, or pointers to training, tips,
and other material that can help new and experienced users of Yocto Project share their knowledge and experience.


== Yocto Project BSP How-Tos ==
Please test all procedures before adding them to this page, and if you do see a problem or improvement, start a
[https://wiki.yoctoproject.org/wiki/index.php?title=Talk:Cookbook&action=edit discussion] (use the discussion tab at the top of this page)
, or edit the page itself!
 
 
== Cookbook Topics ==
 
Here's our initial list of examples we'd like to include in our cookbook.  Those that have been written or are in progress will be linked, the others are on our list to work on.  (As we get more, we may regroup the organization of these topics, but for now this should work:
* Adding packages to your OS image
* Creating and updating recipes with devtool
* Understanding the fetch/unpack/configure/build/package pipeline
* Locating and understanding failures
* Understanding the tmp/work directory structure and what goes where
* Introduction to writing recipes
* Package management
* Application Development
* Configuring your kernel
* And more....
 
== Other Links ==
 
* [http://www.yoctoproject.org/docs/current/yocto-project-qs/yocto-project-qs.html Quick Start Guide]: The official Yocto Project Quick Start Guide contains a step-by-step walk-through showing how to set up your environment and perform your first build
 
* [http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#extendpoky Developer Manual: Common Tasks] section of the Yocto Project documentation


* TomZ's page on how to create and maintain a Yocto Project BSP: [[Yocto_BSP_One-Stop_Shop_(Documentation_Overview,_Getting_Started,_FAQs,_and_more)]]


* Examples section of the documentation: [http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#dev-manual-bsp-appendix Yocto Project Developer's Manual: Appendix A, BSP Development Example]
Here are links that were in a previous version of this Cookbook. (Some seem rather outdated that we'll need to comb through, but we wanted to keep them around for now.)


== Appliance How-Tos ==
* TomZ's page on how to create and maintain a Yocto Project BSP: [[Yocto_BSP_One-Stop_Shop_(Documentation_Overview,_Getting_Started,_FAQs,_and_more)]]


* [[Cookbook:Appliance:Startup_Scripts|Startup scripts]] - How to get things to happen / start automatically
* How to get things to happen or start automatically: [[Cookbook:Appliance:Startup_Scripts|Startup scripts]]

Revision as of 21:56, 19 May 2016

[WORK IN PROGRESS]

This Yocto Project Cookbook collects working examples of how to use the Yocto Project, filling some of the gaps between the Yocto Project Quick Start Guide and the full reference documentation. Like any cookbook, we'll include some basic as well as more complex examples you can follow to learn about the pantry of components and files available, as well as the techniques for manipulating them using Yocto Project tools.

We encourage you, the Yocto Project community, to add your own examples to this Cookbook, or pointers to training, tips, and other material that can help new and experienced users of Yocto Project share their knowledge and experience.

Please test all procedures before adding them to this page, and if you do see a problem or improvement, start a discussion (use the discussion tab at the top of this page) , or edit the page itself!


Cookbook Topics

Here's our initial list of examples we'd like to include in our cookbook. Those that have been written or are in progress will be linked, the others are on our list to work on. (As we get more, we may regroup the organization of these topics, but for now this should work:

  • Adding packages to your OS image
  • Creating and updating recipes with devtool
  • Understanding the fetch/unpack/configure/build/package pipeline
  • Locating and understanding failures
  • Understanding the tmp/work directory structure and what goes where
  • Introduction to writing recipes
  • Package management
  • Application Development
  • Configuring your kernel
  • And more....

Other Links

  • Quick Start Guide: The official Yocto Project Quick Start Guide contains a step-by-step walk-through showing how to set up your environment and perform your first build


Here are links that were in a previous version of this Cookbook. (Some seem rather outdated that we'll need to comb through, but we wanted to keep them around for now.)