AX: AXIsolatedTree::updateChildren sometimes fails to update isolated subtrees when...
[WebKit-https.git] / ReadMe.md
1 # WebKit
2
3 WebKit is a cross-platform web browser engine. On iOS and macOS, it powers Safari, Mail, iBooks, and many other applications.
4
5 ## Feature Status
6
7 Visit [WebKit Feature Status](https://webkit.org/status/) page to see which Web API has been implemented, in development, or under consideration.
8
9 ## Trying the Latest
10
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.
12
13 ## Reporting Bugs
14
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/).
18
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.
20
21 ## Getting the Code
22
23 On Windows, follow the [instructions on our website](https://webkit.org/webkit-on-windows/).
24
25 ### Cloning the Git SVN Repository
26
27 Run the following command to clone WebKit's Git SVN repository:
28
29 ```
30 git clone https://github.com/WebKit/WebKit.git WebKit
31 ```
32
33 If you want to be able to track Subversion revision from your git checkout, you can run the following command to do so:
34
35 ```
36 Tools/Scripts/git-webkit setup-git-svn
37 ```
38
39 For information about this, and other aspects of using Git with WebKit, read [the wiki page](https://trac.webkit.org/wiki/UsingGitWithWebKit).
40
41 ## Building WebKit
42
43 ### Building macOS Port
44
45 Install Xcode and its command line tools if you haven't done so already:
46
47 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.
48 2. **Install the Xcode Command Line Tools** In Terminal, run the command: `xcode-select --install`
49
50 Run the following command to build a debug build with debugging symbols and assertions:
51
52 ```
53 Tools/Scripts/build-webkit --debug
54 ```
55
56 For performance testing, and other purposes, use `--release` instead.
57
58 ### Using Xcode
59
60 You can open `WebKit.xcworkspace` to build and debug WebKit within Xcode.
61
62 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.
63
64 ### Embedded Builds
65
66 iOS, tvOS and watchOS are all considered embedded builds. The first time after you install a new Xcode, you will need to run:
67
68 ```
69 sudo Tools/Scripts/configure-xcode-for-embedded-development
70 ```
71
72 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`.
73
74 Run the following command to build a debug build with debugging symbols and assertions for embedded simulators:
75
76 ```
77 Tools/Scripts/build-webkit --debug --<platform>-simulator
78 ```
79
80 or embedded devices:
81 ```
82 Tools/Scripts/build-webkit --debug --<platform>-device
83 ```
84
85 where `platform` is `ios`, `tvos` or `watchos`.
86
87 ### Building the GTK+ Port
88
89 For production builds:
90
91 ```
92 cmake -DPORT=GTK -DCMAKE_BUILD_TYPE=RelWithDebInfo -GNinja
93 ninja
94 sudo ninja install
95 ```
96
97 For development builds:
98
99 ```
100 Tools/gtk/install-dependencies
101 Tools/Scripts/update-webkitgtk-libs
102 Tools/Scripts/build-webkit --gtk --debug
103 ```
104
105 For more information on building WebKitGTK+, see the [wiki page](https://trac.webkit.org/wiki/BuildingGtk).
106
107 ### Building the WPE Port
108
109 For production builds:
110
111 ```
112 cmake -DPORT=WPE -DCMAKE_BUILD_TYPE=RelWithDebInfo -GNinja
113 ninja
114 sudo ninja install
115 ```
116
117 For development builds:
118
119 ```
120 Tools/wpe/install-dependencies
121 Tools/Scripts/update-webkitwpe-libs
122 Tools/Scripts/build-webkit --wpe --debug
123 ```
124
125 ### Building Windows Port
126
127 For building WebKit on Windows, see the [wiki page](https://webkit.org/webkit-on-windows/).
128
129 ## Running WebKit
130
131 ### With Safari and Other macOS Applications
132
133 Run the following command to launch Safari with your local build of WebKit:
134
135 ```
136 Tools/Scripts/run-safari --debug
137 ```
138
139 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`.
140
141 To run other applications with your local build of WebKit, run the following command:
142
143 ```
144 Tools/Scripts/run-webkit-app <application-path>
145 ```
146
147 ### iOS Simulator
148
149 Run the following command to launch iOS simulator with your local build of WebKit:
150
151 ```
152 run-safari --debug --ios-simulator
153 ```
154
155 In both cases, if you have built release builds instead, use `--release` instead of `--debug`.
156
157 ### Linux Ports
158
159 If you have a development build, you can use the run-minibrowser script, e.g.:
160
161 ```
162 run-minibrowser --debug --wpe
163 ```
164
165 Pass one of `--gtk`, `--jsc-only`, or `--wpe` to indicate the port to use.
166
167 ## Contribute
168
169 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/).
170