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