diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2017-07-21 13:57:25 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2017-07-27 23:00:23 +0100 |
commit | a2dfac68b57b8251dc40c4e4e75b05dbc76f3461 (patch) | |
tree | 0b2f6c04da7b23a2ac6c805b2e70a6f0acb884b8 /documentation/dev-manual/dev-manual-start.xml | |
parent | 38ee8ae87614f790cbdd79137451994c28b69b05 (diff) | |
download | poky-a2dfac68b57b8251dc40c4e4e75b05dbc76f3461.tar.gz |
dev-manua: Added Crops setup section.
(From yocto-docs rev: e2ba131b98705f98463030dde043d858b500690d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual/dev-manual-start.xml')
-rw-r--r-- | documentation/dev-manual/dev-manual-start.xml | 98 |
1 files changed, 93 insertions, 5 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 1332a26416..baf84173f4 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml | |||
@@ -96,12 +96,100 @@ | |||
96 | </section> | 96 | </section> |
97 | 97 | ||
98 | <section id='setting-up-to-use-crops'> | 98 | <section id='setting-up-to-use-crops'> |
99 | <title>Setting Up to Use CROPS</title> | 99 | <title>Setting Up to Use CROss PlatformS (CROPS)</title> |
100 | 100 | ||
101 | <para role='writernotes'> | 101 | <para> |
102 | Need text. | 102 | With |
103 | With CROPS, not sure what the basic package requirements are. | 103 | <ulink url='https://git.yoctoproject.org/cgit/cgit.cgi/crops/about/'>CROPS</ulink>, |
104 | Need to find this out. | 104 | which leverages |
105 | <ulink url='https://www.docker.com/'>Docker Containers</ulink>, | ||
106 | you can create a Yocto Project development environment that | ||
107 | is operating system agnostic. | ||
108 | You can set up a container in which you can develop using the | ||
109 | Yocto Project on a Windows, Mac, or Linux machine. | ||
110 | </para> | ||
111 | |||
112 | <para> | ||
113 | Follow these general steps to prepare a Windows, Mac, or Linux | ||
114 | machine as your Yocto Project development host: | ||
115 | <orderedlist> | ||
116 | <listitem><para> | ||
117 | <emphasis>Go to the Docker Installation Site:</emphasis> | ||
118 | <ulink url='https://www.docker.com/what-docker'>Docker</ulink> | ||
119 | is a software container platform that you need to install | ||
120 | on the host development machine. | ||
121 | To start the installation process, see the | ||
122 | <ulink url='https://docs.docker.com/engine/installation/'>Docker Installation</ulink> | ||
123 | site. | ||
124 | </para></listitem> | ||
125 | <listitem><para> | ||
126 | <emphasis>Choose Your Docker Edition:</emphasis> | ||
127 | Docker comes in several editions. | ||
128 | For the Yocto Project, the stable community edition | ||
129 | (i.e. "Docker CE Stable") is adequate. | ||
130 | You can learn more about the Docker editions from the | ||
131 | site. | ||
132 | </para></listitem> | ||
133 | <listitem><para> | ||
134 | <emphasis>Go the Install Site for Your Platform:</emphasis> | ||
135 | Click the link for the Docker edition associated with | ||
136 | your development host machine's native software. | ||
137 | For example, if your machine is running Microsoft | ||
138 | Windows Version 10 and you want the Docker CE Stable | ||
139 | edition, click that link under "Supported Platforms". | ||
140 | </para></listitem> | ||
141 | <listitem><para> | ||
142 | <emphasis>Understand What You Need:</emphasis> | ||
143 | The install page has pre-requisites your machine must | ||
144 | meet. | ||
145 | Be sure you read through this page and make sure your | ||
146 | machine meets the requirements to run Docker. | ||
147 | If your machine does not meet the requirements, the page | ||
148 | has instructions to handle exceptions. | ||
149 | For example, to run Docker on Windows 10, you must have | ||
150 | the pro version of the operating system. | ||
151 | If you have the home version, you need to install the | ||
152 | <ulink url='https://docs.docker.com/toolbox/overview/#ready-to-get-started'>Docker Toolbox</ulink>. | ||
153 | </para> | ||
154 | |||
155 | <para>Another example is that a Windows machine needs to | ||
156 | have Microsoft Hyper-V. | ||
157 | If you have a legacy version of the the Microsoft | ||
158 | operating system or for any other reason you do not have | ||
159 | Microsoft Hyper-V, you would have to enter the BIOS and | ||
160 | enable virtualization. | ||
161 | </para></listitem> | ||
162 | <listitem><para> | ||
163 | <emphasis>Install the Software:</emphasis> | ||
164 | Once you have understood all the pre-requisites, you can | ||
165 | download and install the appropriate software. | ||
166 | Follow the instructions for your specific machine and | ||
167 | the type of the software you need to install. | ||
168 | </para></listitem> | ||
169 | <listitem><para> | ||
170 | <emphasis>Optionally Orient Yourself With Dockers:</emphasis> | ||
171 | If you are unfamiliar with Dockers and the container | ||
172 | concept, you can learn more here - | ||
173 | <ulink url='https://docs.docker.com/get-started/'></ulink>. | ||
174 | You should be able to launch Docker or the Docker Toolbox | ||
175 | and have a terminal shell on your development host. | ||
176 | </para></listitem> | ||
177 | <listitem><para> | ||
178 | <emphasis>Set Up the Containers to Use the Yocto Project:</emphasis> | ||
179 | Go to | ||
180 | <ulink url='https://github.com/crops/docker-win-mac-docs/wiki'></ulink> | ||
181 | and follow the directions for your particular | ||
182 | development host (i.e. Linux, Mac, or Windows).</para> | ||
183 | |||
184 | <para>Once you complete the setup instructions for your | ||
185 | machine, you have the Poky, Extensible SDK, and Toaster | ||
186 | containers available. | ||
187 | You can click those links from the page and learn more | ||
188 | about using each of those containers. | ||
189 | </para></listitem> | ||
190 | </orderedlist> | ||
191 | Once you have a container set up, everything is in place to | ||
192 | develop just as if you were running on a native Linux machine. | ||
105 | </para> | 193 | </para> |
106 | </section> | 194 | </section> |
107 | 195 | ||