Not reviewed: chromium baselines.
[WebKit-https.git] / Websites / webkit.org / building / build.html
1 <?php
2     $title = "Building WebKit";
3     include("../header.inc");
4 ?>
5
6 <h2>Building WebKit</h2>
7
8 Building WebKit requires that you have the proper <a href="tools.html">developer tools
9 installed</a> and that you have a copy of the <a href="checkout.html">WebKit source tree</a>.
10
11 <div class="windows-instructions">
12 <h4>Windows</h4>
13 <ol>
14 <li><p>Open a Cygwin Shell (if not already open from checking out sources)</p>
15 <p>Double-click the Cygwin icon on your Desktop to launch a new shell.
16 </ol>
17 </div>
18
19 <ol>
20 <li><p>Run the <code>build-webkit</code> <a href="/coding/scripts.html">script</a>
21 to build WebKit.</p>
22 <p>Use the <code>--debug</code> option for a debug build, which includes
23 debugging symbols and assertions:</p>
24 <p class="code">build-webkit --debug</p>
25 </li>
26 </ol>
27
28 <p>By default, <code>build-webkit</code> places build products in <code>WebKitBuild</code>.  You can specify a different build
29 location on Mac in your Xcode preferences.  On other platforms, the <code>WEBKITOUTPUTDIR</code> environment variable can be used to
30 set a different build products location. If you have set up a custom build location, then <code>build-webkit</code> will
31 place the build products there.</p>
32
33 <div class="windows-instructions">
34 <h4>Windows</h4>
35 <p>A common source of build errors on Windows is Visual C++ Express forgetting the Platform SDK paths.  If you have trouble building WebKit,
36 double check that the paths you set during <a href="http://msdn.microsoft.com/en-us/library/ms235626(VS.80).aspx">step 2 of the Platform SDK Installation</a>
37 are still there and add them again if necessary.</p>
38 <p>Don't forget that if you have any questions or problems building WebKit, feel free to <a href="/contact.html">get in touch!</a></p>
39 </div>
40
41 <p>Once your build has finished, you can <a href="run.html">run it inside
42 Safari.</a></p>
43
44 <h2>Building WebKit from Xcode</h2>
45 <p>To build from within Xcode, you can use the WebKit workspace. Ensure that the Products and Intermediates locations for the workspace match those used by <code>build-webkit</code> by choosing File > Workspace Settings and clicking the Advanced button, selecting Custom, Relative to Workspace, and entering WebKitBuild both for Products and for Intermediates. Note that if you have specified a custom build location in Xcode preferences, then you don&rsquo;t need to do this.</p>
46
47 <h2>Setting a Default Configuration</h2>
48 <ol>
49 <li><p>To set a default build configuration for <code>build-webkit</code> and
50 other <a href="/coding/scripts.html">scripts</a>, use the
51 <code>set-webkit-configuration</code> script:</p>
52 <p class="code">set-webkit-configuration --debug</p>
53 <p class="code">set-webkit-configuration --release</p>
54 </li>
55 </ol>
56
57 <?php
58     include("../footer.inc");
59 ?>