https://bugs.webkit.org/show_bug.cgi?id=189594
[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 git://git.webkit.org/WebKit.git WebKit
31 ```
32
33 If you want to be able to commit changes to the repository, or just want to check out branches that aren’t contained in WebKit.git, you will need track WebKit's Subversion repository. You can run the following command to configure this and other options of the new Git clone for WebKit development.
34
35 ```
36 Tools/Scripts/webkit-patch setup-git-clone
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 ### Checking out the Subversion Repository
42
43 If you don't want to use Git, run the following command to check out WebKit's Subversion repository:
44
45 ```
46 svn checkout https://svn.webkit.org/repository/webkit/trunk WebKit
47 ```
48
49 ## Building WebKit
50
51 ### Building macOS Port
52
53 Install Xcode and its command line tools if you haven't done so already:
54
55 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.
56 2. **Install the Xcode Command Line Tools** In Terminal, run the command: `xcode-select --install`
57
58 Run the following command to build a debug build with debugging symbols and assertions:
59
60 ```
61 Tools/Scripts/build-webkit --debug
62 ```
63
64 For performance testing, and other purposes, use `--release` instead.
65
66 ### Using Xcode
67
68 You can open `WebKit.xcworkspace` to build and debug WebKit within Xcode.
69
70 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.
71
72 ### Building iOS Port
73
74 The first time after you install a new Xcode, you will need to run the following command to enable Xcode to build command line tools for iOS Simulator:
75
76 ```
77 sudo Tools/Scripts/configure-xcode-for-ios-development
78 ```
79
80 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`.
81
82 Run the following command to build a debug build with debugging symbols and assertions for iOS:
83
84 ```
85 Tools/Scripts/build-webkit --debug --ios-simulator.
86 ```
87
88 ### Building the GTK+ Port
89
90 For production builds:
91
92 ```
93 cmake -DPORT=GTK -DCMAKE_BUILD_TYPE=RelWithDebInfo -GNinja
94 ninja
95 sudo ninja install
96 ```
97
98 For development builds:
99
100 ```
101 Tools/gtk/install-dependencies
102 Tools/Scripts/update-webkitgtk-libs
103 Tools/Scripts/build-webkit --gtk --debug
104 ```
105
106 For more information on building WebKitGTK+, see the [wiki page](https://trac.webkit.org/wiki/BuildingGtk).
107
108 ### Building the WPE Port
109
110 For production builds:
111
112 ```
113 cmake -DPORT=WPE -DCMAKE_BUILD_TYPE=RelWithDebInfo -GNinja
114 ninja
115 sudo ninja install
116 ```
117
118 For development builds:
119
120 ```
121 Tools/wpe/install-dependencies
122 Tools/Scripts/update-webkitwpe-libs
123 Tools/Scripts/build-webkit --wpe --debug
124 ```
125
126 ### Building Windows Port
127
128 For building WebKit on Windows, see the [wiki page](https://webkit.org/webkit-on-windows/).
129
130 ## Running WebKit
131
132 ### With Safari and Other macOS Applications
133
134 Run the following command to launch Safari with your local build of WebKit:
135
136 ```
137 Tools/Scripts/run-safari --debug
138 ```
139
140 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`.
141
142 To run other applications with your local build of WebKit, run the following command:
143
144 ```
145 Tools/Scripts/run-webkit-app <application-path>
146 ```
147
148 ### iOS Simulator
149
150 Run the following command to launch iOS simulator with your local build of WebKit:
151
152 ```
153 run-safari --debug --ios-simulator
154 ```
155
156 In both cases, if you have built release builds instead, use `--release` instead of `--debug`.
157
158 ### Linux Ports
159
160 If you have a development build, you can use the run-minibrowser script, e.g.:
161
162 ```
163 run-minibrowser --debug --wpe
164 ```
165
166 Pass one of `--gtk`, `--jsc-only`, or `--wpe` to indicate the port to use.
167
168 ## Contribute
169
170 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/).
171