358420da56f0b6940e1dca8a0f3cb98bf71a4a7a
[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="unix-instructions">
16 <h4>Mac OS X or Linux</h4>
17 <ol>
18     <li>
19         <p>Open a shell.</p>
20         <p>On OS X, you can use the <i>Terminal</i> App, which resides in /Applications/Utilities.</p>
21     </li>
22     <li>
23         <p>You can download a snapshot of the WebKit source tree from
24             <a href="http://nightly.webkit.org/files/WebKit-SVN-source.tar.bz2">http://nightly.webkit.org/files/WebKit-SVN-source.tar.bz2</a>.
25             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>
26         <p class="code">svn switch --relocate http://svn.webkit.org/repository/webkit/trunk https://svn.webkit.org/repository/webkit/trunk</p>
27         <p>Type these commands to check out the WebKit source tree:</p>
28         <p class="code">tar jxvf WebKit-SVN-source.tar.bz2<br>cd webkit</p>
29         <div>
30             <p>Alternatively, type this command to check out the WebKit source tree:</p>
31             <p class="code">svn checkout https://svn.webkit.org/repository/webkit/trunk WebKit</p>
32         </div>
33     </li>
34     <li>
35         <p>Run the <code>./Tools/Scripts/update-webkit</code> <a href="/coding/scripts.html">script</a> to update your source tree.</p>
36     </li>
37 </ol>
38 </div>
39
40 <div class="windows-instructions">
41 <h4>Windows</h4>
42 <ol>
43     <li>
44         <p>Open a Cygwin Shell</p>
45         <p>Double-click the Cygwin icon on your Desktop to launch a new shell.</p>
46     </li>
47     <li>
48         <p>You can download a snapshot of the WebKit source tree from
49             <a href="http://nightly.webkit.org/files/WebKit-SVN-source.tar.bz2">http://nightly.webkit.org/files/WebKit-SVN-source.tar.bz2</a>.
50             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>
51         <p class="code">svn switch --relocate http://svn.webkit.org/repository/webkit/trunk https://svn.webkit.org/repository/webkit/trunk</p>
52         <p>Type these commands to check out the WebKit source tree:</p>
53         <p class="code">tar jxvf WebKit-SVN-source.tar.bz2<br>cd webkit</p>
54         <div>
55             <p>Alternatively, type this command to check out the WebKit source tree:</p>
56             <p class="code">svn checkout https://svn.webkit.org/repository/webkit/trunk WebKit</p>
57         </div>
58     </li>
59     <li>
60         <p>Install the WebKit Support Libraries</p>
61         <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>
62         <p>If the file is incorrectly named, rename it to <code>WebKitSupportLibrary.zip</code>. Do not extract its contents.</p>
63     </li>
64     <li>
65         <p>Run the <code>./Tools/Scripts/update-webkit</code> <a href="/coding/scripts.html">script</a> to update your source tree.</p>
66         <p>If you downloaded the tarball, this will bring it up to date.  Windows users
67             must always execute this command after first obtaining the code, since it will
68             download additional libraries that are needed to build.</p>
69     </li>
70 </ol>
71 </div>
72
73 <p>Once you have a current tree, the next step is
74 <a href="build.html">building WebKit</a>.</p>
75
76 <h2>Checking Out with Git</h2>
77 <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>
78 <p class="code">git clone git://git.webkit.org/WebKit.git WebKit</p>
79
80 <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. You can run the following command to configure this and other options of the new Git clone for WebKit development.</p>
81 <p class="code">Tools/Scripts/webkit-patch setup-git-clone</p>
82
83 <p>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>
84
85 <h2>Keeping up to Date</h2>
86 <p>At any time, you can rerun the <code>update-webkit</code> script to update
87 your source tree.</p>
88
89 <?php
90 include("../footer.inc");
91 ?>