Not reviewed: chromium baselines.
[WebKit-https.git] / Websites / webkit.org / building / checkout.html
1 <?php
2 $title = "Getting the Code";
3 include("../header.inc");
4 ?>
5 <h2>Getting WebKit</h2>
6 <p>To download a pre-built bundle containing the latest WebKit, visit <a href="http://nightly.webkit.org/">WebKit Nightly Builds</a>.</p>
7
8 <h2>Browsing the Code</h2>
9 <p>To browse the source code online, visit <a href="https://trac.webkit.org/browser">WebKit Trac</a>.
10
11 <h2>Checking Out with Subversion</h2>
12 <p>To work with the WebKit source tree, you will need a Subversion or a Git client installed.
13 See <a href="tools.html">Installing Developer Tools</a> for information on how
14 to install Subversion.</p>
15 <div class="mac-instructions">
16 <h4>Mac OS X</h4>
17 <ol>
18 <li><p>Open Terminal</p>
19 <p>Terminal resides in /Applications/Utilities. The Finder Go menu provides a quick way to navigate there.</p>
20 </ol>
21 </div>
22
23 <div class="windows-instructions">
24 <h4>Windows</h4>
25 <ol>
26 <li><p>Open a Cygwin Shell</p>
27 <p>Double-click the Cygwin icon on your Desktop to launch a new shell.
28 </ol>
29 </div>
30
31 <ol>
32 <li><p>Type this command to check out the WebKit source tree:</p>
33 <p class="code">svn checkout https://svn.webkit.org/repository/webkit/trunk WebKit</p>
34 <p>Alternatively you can download a snapshot of the WebKit source tree from 
35 <a href="http://nightly.webkit.org/files/WebKit-SVN-source.tar.bz2">http://nightly.webkit.org/files/WebKit-SVN-source.tar.bz2</a>.  It is updated every six hours. Note the archived checkout uses an HTTP connection. We recommend running the following command to use HTTPS instead:</p>
36 <p class="code">svn switch --relocate http://svn.webkit.org/repository/webkit/trunk https://svn.webkit.org/repository/webkit/trunk</p>
37 </li>
38 </ol>
39
40 <div class="windows-instructions">
41 <h4>Windows</h4>
42 <ol>
43 <li><p>Install the WebKit Support Libraries</p>
44 <p>Download the <a href="http://developer.apple.com/opensource/internet/webkit_sptlib_agree.html">WebKit Support Libraries</a> to the root of your source tree (<code>C:\cygwin\home\&lt;username&gt;\WebKit</code>).</p>
45 <p>If the file is incorrectly named, rename it to <code>WebKitSupportLibrary.zip</code>. Do not extract its contents.</p>
46 </ol>
47 </div>
48
49 <ol>
50 <li><p>Run the <code>update-webkit</code> <a href="/coding/scripts.html">script</a>
51 to update your source tree.</p>
52 <p>If you downloaded the tarball, this will bring it up to date.  Windows users
53 must always execute this command after first obtaining the code, since it will
54 download additional libraries that are needed to build.</p>
55 </ol>
56
57 <p>Once you have a current tree, the next step is
58 <a href="build.html">building WebKit</a>.</p>
59
60 <h2>Checking Out with Git</h2>
61 <p>To work with the WebKit source tree using a Git client, install a Git client with Subversion support and run the following command on your terminal:</p>
62 <p class="code">git clone git://git.webkit.org/WebKit.git WebKit</p>
63
64 <p>If you want to be able to commit changes to the Subversion repository, or just want to check out branches that aren't contained in WebKit.git, you will need track the Subversion repository. For information about this, and other aspects of using Git with WebKit, read <a href="https://trac.webkit.org/wiki/UsingGitWithWebKit">the wiki page</a>.</p>
65
66 <h2>Keeping up to Date</h2>
67 <p>At any time, you can rerun the <code>update-webkit</code> script to update
68 your source tree.</p>
69
70 <?php
71 include("../footer.inc");
72 ?>