3 WebKit is a cross-platform web browser engine. On iOS and macOS, it powers Safari, Mail, iBooks, and many other applications.
7 Visit [WebKit Feature Status](https://webkit.org/status/) page to see which Web API has been implemented, in development, or under consideration.
11 On macOS, [download Safari Technology Preview](https://webkit.org/downloads/) to test the latest version of WebKit. On Linux, download [Epiphany Technology Preview](https://webkitgtk.org/epiphany-tech-preview). On Windows, you'll have to build it yourself.
15 1. [Search WebKit Bugzilla](https://bugs.webkit.org/query.cgi?format=specific&product=WebKit) to see if there is an existing report for the bug you've encountered.
16 2. [Create a Bugzilla account](https://bugs.webkit.org/createaccount.cgi) to to report bugs (and to comment on them) if you haven't done so already.
17 3. File a bug in accordance with [our guidelines](https://webkit.org/bug-report-guidelines/).
19 Once your bug is filed, you will receive email when it is updated at each stage in the [bug life cycle](https://webkit.org/bug-life-cycle). After the bug is considered fixed, you may be asked to download the [latest nightly](https://webkit.org/nightly) and confirm that the fix works for you.
23 On Windows, follow the [instructions on our website](https://webkit.org/webkit-on-windows/).
25 ### Cloning the Git SVN Repository
27 Run the following command to clone WebKit's Git SVN repository:
30 git clone git@github.com:WebKit/WebKit.git WebKit
36 git clone https://github.com/WebKit/WebKit.git WebKit
39 If you want to be able to track Subversion revision from your git checkout, you can run the following command to do so:
42 Tools/Scripts/git-webkit setup-git-svn
45 For information about this, and other aspects of using Git with WebKit, read [the wiki page](https://trac.webkit.org/wiki/UsingGitWithWebKit).
47 ### Checking out the Subversion Repository
49 If you don't want to use Git, run the following command to check out WebKit's Subversion repository:
52 svn checkout https://svn.webkit.org/repository/webkit/trunk WebKit
57 ### Building macOS Port
59 Install Xcode and its command line tools if you haven't done so already:
61 1. **Install Xcode** Get Xcode from https://developer.apple.com/downloads. To build WebKit for OS X, Xcode 5.1.1 or later is required. To build WebKit for iOS Simulator, Xcode 7 or later is required.
62 2. **Install the Xcode Command Line Tools** In Terminal, run the command: `xcode-select --install`
64 Run the following command to build a debug build with debugging symbols and assertions:
67 Tools/Scripts/build-webkit --debug
70 For performance testing, and other purposes, use `--release` instead.
74 You can open `WebKit.xcworkspace` to build and debug WebKit within Xcode.
76 If you don't use a custom build location in Xcode preferences, you have to update the workspace settings to use `WebKitBuild` directory. In menu bar, choose File > Workspace Settings, then click the Advanced button, select "Custom", "Relative to Workspace", and enter `WebKitBuild` for both Products and Intermediates.
80 iOS, tvOS and watchOS are all considered embedded builds. The first time after you install a new Xcode, you will need to run:
83 sudo Tools/Scripts/configure-xcode-for-embedded-development
86 Without this step, you will see the error message: "`target specifies product type ‘com.apple.product-type.tool’, but there’s no such product type for the ‘iphonesimulator’ platform.`" when building target `JSCLLIntOffsetsExtractor` of project `JavaScriptCore`.
88 Run the following command to build a debug build with debugging symbols and assertions for embededded simulators:
91 Tools/Scripts/build-webkit --debug --<platform>-simulator
96 Tools/Scripts/build-webkit --debug --<platform>-device
99 where `platform` is `ios`, `tvos` or `watchos`.
101 ### Building the GTK+ Port
103 For production builds:
106 cmake -DPORT=GTK -DCMAKE_BUILD_TYPE=RelWithDebInfo -GNinja
111 For development builds:
114 Tools/gtk/install-dependencies
115 Tools/Scripts/update-webkitgtk-libs
116 Tools/Scripts/build-webkit --gtk --debug
119 For more information on building WebKitGTK+, see the [wiki page](https://trac.webkit.org/wiki/BuildingGtk).
121 ### Building the WPE Port
123 For production builds:
126 cmake -DPORT=WPE -DCMAKE_BUILD_TYPE=RelWithDebInfo -GNinja
131 For development builds:
134 Tools/wpe/install-dependencies
135 Tools/Scripts/update-webkitwpe-libs
136 Tools/Scripts/build-webkit --wpe --debug
139 ### Building Windows Port
141 For building WebKit on Windows, see the [wiki page](https://webkit.org/webkit-on-windows/).
145 ### With Safari and Other macOS Applications
147 Run the following command to launch Safari with your local build of WebKit:
150 Tools/Scripts/run-safari --debug
153 The `run-safari` script sets the `DYLD_FRAMEWORK_PATH` environment variable to point to your build products, and then launches `/Applications/Safari.app`. `DYLD_FRAMEWORK_PATH` tells the system loader to prefer your build products over the frameworks installed in `/System/Library/Frameworks`.
155 To run other applications with your local build of WebKit, run the following command:
158 Tools/Scripts/run-webkit-app <application-path>
163 Run the following command to launch iOS simulator with your local build of WebKit:
166 run-safari --debug --ios-simulator
169 In both cases, if you have built release builds instead, use `--release` instead of `--debug`.
173 If you have a development build, you can use the run-minibrowser script, e.g.:
176 run-minibrowser --debug --wpe
179 Pass one of `--gtk`, `--jsc-only`, or `--wpe` to indicate the port to use.
183 Congratulations! You’re up and running. Now you can begin coding in WebKit and contribute your fixes and new features to the project. For details on submitting your code to the project, read [Contributing Code](https://webkit.org/contributing-code/).