Add debugger related functions to the InspectorController and
[WebKit-https.git] / WebKitSite / 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="http://trac.webkit.org/projects/webkit/browser">WebKit Trac</a>.
10
11 <h2>Checking Out</h2>
12 <p>To work with the WebKit source tree, you will need a Subversion 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>Install a Subversion Client</p>
19 <p>Subversion (svn) is the source code management tool used by the WebKit Open Source Project. A <a href="http://homepage.mac.com/hiirem/svkbuilds.html">Subversion 1.4 client for Mac OS X 10.4</a> is available.</p>
20 <li><p>Open Terminal</p>
21 <p>Terminal resides in /Applications/Utilities. The Finder Go menu provides a quick way to navigate there.</p>
22 </ol>
23 </div>
24
25 <div class="windows-instructions">
26 <h4>Windows</h4>
27 <ol>
28 <li><p>Open a Cygwin Shell</p>
29 <p>Double-click the Cygwin icon on your Desktop to launch a new shell.
30 </ol>
31 </div>
32
33 <ol>
34 <li><p>Type this command to check out the WebKit source tree:</p>
35 <p class="code">svn checkout http://svn.webkit.org/repository/webkit/trunk WebKit</p>
36 <p>Alternatively you can download a snapshot of the WebKit source tree from 
37 <a href="http://live.nightly.webkit.org/files/WebKit-SVN-source.tar.bz2">http://live.nightly.webkit.org/files/WebKit-SVN-source.tar.bz2</a>.  It is updated every six hours.</p>
38 </li>
39 </ol>
40
41 <div class="windows-instructions">
42 <h4>Windows</h4>
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 (<tt>C:\cygwin\home\&lt;username&gt;\WebKit</tt>).</p>
45 <p>If the file is incorrectly named, rename it to <tt>WebKitSupportLibrary.zip</tt>. Do not extract its contents.</p>
46 </div>
47
48 <ol>
49 <li><p>Type this command to update your source tree:</p>
50 <p class="code">WebKit/WebKitTools/Scripts/update-webkit</p>
51 <p>If you downloaded the tarball, this will bring it up to date.  Windows users
52 must always execute this command after first obtaining the code, since it will
53 download additional libraries that are needed to build.</p>
54 </ol>
55
56 <p>Once you have a current tree, the next step is
57 <a href="build.html">building WebKit</a>.</p>
58
59 <h2>Keeping up to Date</h2>
60 <p>At any time, you can retype the <tt>update-webkit</tt> command to update your source tree:</p>
61 <p class="code">WebKit/WebKitTools/Scripts/update-webkit</p>
62
63 <hr>
64 <p>It's handy to put <tt>WebKit/WebKitTools/Scripts</tt> in your shell path so you can type commands like <tt>update-webkit</tt> without specifying a full path.</p>
65 <?php
66 include("../footer.inc");
67 ?>