Add ReadMe.md to WebKit
[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 [Downloading Safari Technology Preview](https://webkit.org/downloads/) to test the latest version of WebKit.
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 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 The following instructions are for building WebKit on Mac. For other ports, follow these instructions on our website:
52
53 * [Windows](https://webkit.org/webkit-on-windows/)
54 * [GTK+](https://trac.webkit.org/wiki/BuildingGtk)
55
56 ### Building Mac Port
57
58 Install Xcode and its command line tools if you haven't done so already:
59
60 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.
61 2. **Install the Xcode Command Line Tools** In Terminal, run the command: `xcode-select --install`
62
63 Run the following command to build a debug build with debugging symbols and assertions:
64
65 ```
66 `Tools/Scripts/build-webkit --debug`
67 ```
68
69 For performance testing, and other purposes, use `--release` instead.
70
71 ### Using Xcode
72
73 You can open `WebKit.xcworkspace` to build and debug WebKit within WebKit.
74
75 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.
76
77 ### Building  iOS Port
78
79 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:
80
81 ```
82  sudo Tools/Scripts/configure-xcode-for-ios-development
83 ```
84
85 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`.
86
87 Run the following command to build a debug build with debugging symbols and assertions for iOS:
88
89 ```
90 `Tools/Scripts/build-webkit --debug --ios-simulator.`
91 ```
92
93 You can also change the default build configuration using the following commands:
94
95 ```
96 `Tools/Scripts/set-webkit-configuration --debug
97 Tools/Scripts/set-webkit-configuration --release`
98 ```
99
100 ## Running WebKit
101
102 ### With Safari and Other macOS Applications
103
104 Run the following command to launch Safari with your local build of WebKit:
105
106 ```
107 `Tools/Scripts/run-safari --debug`
108 ```
109
110 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`.
111
112 To run other applications with your local build of WebKit, run the following command:
113
114 ```
115 `Tools/Scripts/run-webkit-app <application-path>`
116 ```
117
118 ### iOS Simulator
119
120 Run the following command to launch iOS simulator with your local build of WebKit:
121
122 ```
123 `run-safari --debug --ios-simulator`
124 ```
125
126 In both cases, if you have built release builds instead, use `--release` instead of `--debug`.
127
128 ## Contribute
129
130 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/).
131