Put styles directly in html, rather than including css (to work with collabnet)
[people/mcb30/edk2.git] / www / step-by-step-instructions.html
1 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
2
3 <head>
4   <style type="text/css">
5           <!--
6     .main-title, .main-details {
7       font-size: 11pt;
8     }
9     
10     .main-details {
11       margin-top: 0.19in;
12       margin-bottom: 0.19in
13     }
14     
15     .main-title {
16       font-weight: bold;
17       margin-top: 0in;
18       margin-bottom: 0.08in;
19       border-bottom: thin solid black;
20     }
21     
22     .build-step-title {
23       font-size: 11pt;
24       font-weight: bold;
25       margin-top: 0.19in;
26       margin-bottom: 0.19in
27     }
28     
29     .build-step-details {
30     }
31     
32     .build-step-code {
33       font-family: "courier new", "courier", "monospace";
34       border: 1px dashed;
35       margin-right: 0.25in;
36       padding: 2pt 4pt 2pt 4pt;
37       background-color: #F0F0F0;
38     }
39     
40     .build-step-details, .build-step-code, .build-step-title {
41       margin-left: 0.25in;
42     }
43     
44     table.build-step-details td {
45       border-style: hidden;
46     }
47     -->
48   </style>
49 </head>
50
51 <Body>
52
53 <h2 class="main-title">
54   Step-by-step (walk-throughs) for building with edk2
55 </h2>
56
57 <p class="main-details">
58   <font size="2">
59     This page contains some step-by-step guides in an attempt to give
60     a highly detailed description of how to set up building on an edk2
61     system.&nbsp;
62     A few different operating systems are targeted.&nbsp;
63     It is hoped that these examples can either provide exact steps for
64     setting up an edk2 build environment.&nbsp;
65     If instructions are not available for your exact system configuration,
66     you may still be able to 'tweak' the instructions to work on your
67     system.
68   </font>
69 </p>
70
71 <font size="2">
72   <ul>
73     <li><a href="#MacOSX10.5">Mac OS X 10.5</a> (Leopard)</li>
74     <li><a href="#Ubuntu8.04">Ubuntu 8.04</a></li>
75   </ul>
76 </font>
77
78 <h2 class="main-title">
79   <a name="MacOSX10.5"></a>
80   Mac OS X 10.5
81 </h2>
82
83 <h3 class="build-step-title">
84   Work in progress...
85 </h3>
86
87 <!--
88 <p class="build-step-details">
89   These instructions for OS X 10.5 are currently under construction.&nbsp;
90   Please do not try to use them until this notice is removed!
91 </p>
92 -->
93
94 <h2 class="main-title">
95   <a name="Ubuntu8.04"></a>
96   Ubuntu 8.04
97 </h2>
98
99 <h3 class="build-step-title">
100   Work in progress...
101 </h3>
102
103 <p class="build-step-details">
104   These instructions for Ubuntu 8.04 are currently under construction.&nbsp;
105   Please do not try to use them until this notice is removed!
106 </p>
107
108 <h3 class="build-step-title">
109   Getting started &amp; Instructions for the instructions
110 </h3>
111
112 <p class="build-step-details">
113   These instructions will be written as a series of commands executed from
114   a command terminal.&nbsp;
115   To open the command terminal application, open the "Applications" menu,
116   then open the "Accessories" sub-menu, and then select the "Terminal"
117   application.
118 </p>
119
120 <p class="build-step-details">
121   Often these instructions will contain a command which needs to be
122   executed in the terminal window.&nbsp; For example:
123 </p>
124
125 <pre class="build-step-code">
126 bash:~$ <b>echo this bold text is a sample command</b>
127 </pre>
128
129 <p class="build-step-details">
130   To execute this command, highlight the <b>bold</b> text of the 
131   command in your web browser.&nbsp;
132   After the text is highlighted, you can paste the text into the terminal
133   window with the middle mouse button.&nbsp;
134 </p>
135 <p class="build-step-details">
136   There may be other ways to copy and paste the text into the terminal.&nbsp;
137   For example, you can usually press 'Ctrl-C' within your web browser to copy
138   the text, and within the gnome-terminal program you can then press
139   'Ctrl-<b>Shift</b>-V' to paste the text.&nbsp;
140   After pasting the command into the shell, you may need to press the
141   enter or return key to execute the command.&nbsp;
142   If all else fails, you can type the command by hand.
143 </p>
144
145 <p class="build-step-details">
146   Some commands are very long, and we use the backslash character (\) to
147   tell the shell program that the line is not finished.&nbsp; For example:
148 </p>
149
150 <pre class="build-step-code">
151 bash:~$ <b>echo this bold text is a sample command \
152           which is broken into two lines</b>
153 </pre>
154
155 <p class="build-step-details">
156   When you copy and paste, make sure you include all lines of the command.&nbsp;
157   If you are typing the command, you can remove the backslash character (\)
158   and combine the lines into a single line if you prefer.
159 </p>
160
161 <p class="build-step-details">
162   If a command starts with the 'sudo' command, then you may be prompted for
163   your user password.&nbsp;
164   This will be the same password as you used to login to the system.
165 </p>
166
167 <p class="build-step-details">
168   For the purposes of this set of instructions, we will be using the following
169   paths.&nbsp;
170 </p>
171
172 <table class="build-step-details">
173   <tr>
174     <td>
175       <a href="https://edk2.tianocore.org">Edk2</a> source tree:
176     </td>
177     <td>
178       <b>~/src/edk2</b>
179     </td>
180   </tr>
181   <tr>
182     <td>
183       <a href="https://buildtools.tianocore.org">Buildtools</a> source tree:
184     </td>
185     <td>
186       <b>~/src/buildtools</b>
187     </td>
188   </tr>
189   <tr>
190     <td>
191       gcc x64 cross-compiler installation:
192     </td>
193     <td>
194       <b>~/programs/gcc/x64</b>
195     </td>
196   </tr>
197 </table>
198
199 <p class="build-step-details">
200   You will need to change the commands if you want to use different
201   locations, but this is not recommended unless you are sure that you
202   know what you are doing.
203 </p>
204
205 <h3 class="build-step-title">
206     Install tools from apt
207 </h3>
208
209 <p class="build-step-details">
210   Several ubuntu packages will be needed to fully set up an edk2 build
211   environment.&nbsp;
212   In order to easily install all the requirements, you need to run
213   this command.
214 </p>
215
216 <pre class="build-step-code">
217 bash:~$ <b>sudo apt-get install build-essentials uuid-dev \
218           python-setuptools texinfo bison flex libgmp3-dev \
219           libmpfr-dev</b>
220 </pre>
221
222 <h3 class="build-step-title">
223     Install python antlr module
224 </h3>
225
226 <p class="build-step-details">
227   In order to install the python antlr module, we use the 'easy_install'
228   command.&nbsp;
229   The following command is the latest version right now, but if
230   you encounter difficulties, you may want to confirm the version at
231   <a href="http://www.antlr.org/download/Python">http://www.antlr.org/download/Python</a>.
232 </p>
233
234 <pre class="build-step-code">
235 bash:~$ <b>sudo easy_install \
236   http://www.antlr.org/download/Python/antlr_python_runtime-3.0.1-py2.5.egg</b>
237 </pre>
238
239
240 </Body>
241