Use WTF::Function instead of std::function in NetworkProcess code
[WebKit-https.git] / ReadMe.md
index 1dcbbc6..7aa40a6 100644 (file)
--- a/ReadMe.md
+++ b/ReadMe.md
@@ -27,13 +27,13 @@ On Windows, follow the [instructions on our website](https://webkit.org/webkit-o
 Run the following command to clone WebKit's Git SVN repository:
 
 ```
-`git clone git://git.webkit.org/WebKit.git WebKit`
+git clone git://git.webkit.org/WebKit.git WebKit
 ```
 
 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.
 
 ```
-`Tools/Scripts/webkit-patch setup-git-clone`
+Tools/Scripts/webkit-patch setup-git-clone
 ```
 
 For information about this, and other aspects of using Git with WebKit, read [the wiki page](https://trac.webkit.org/wiki/UsingGitWithWebKit).
@@ -43,16 +43,11 @@ For information about this, and other aspects of using Git with WebKit, read [th
 Run the following command to check out WebKit's subversion repository:
 
 ```
-`svn checkout https://svn.webkit.org/repository/webkit/trunk WebKit`
+svn checkout https://svn.webkit.org/repository/webkit/trunk WebKit
 ```
 
 ## Building WebKit
 
-The following instructions are for building WebKit on Mac. For other ports, follow these instructions on our website:
-
-* [Windows](https://webkit.org/webkit-on-windows/)
-* [GTK+](https://trac.webkit.org/wiki/BuildingGtk)
-
 ### Building Mac Port
 
 Install Xcode and its command line tools if you haven't done so already:
@@ -63,7 +58,7 @@ Install Xcode and its command line tools if you haven't done so already:
 Run the following command to build a debug build with debugging symbols and assertions:
 
 ```
-`Tools/Scripts/build-webkit --debug`
+Tools/Scripts/build-webkit --debug
 ```
 
 For performance testing, and other purposes, use `--release` instead.
@@ -74,7 +69,7 @@ You can open `WebKit.xcworkspace` to build and debug WebKit within WebKit.
 
 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.
 
-### Building  iOS Port
+### Building iOS Port
 
 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:
 
@@ -87,16 +82,34 @@ Without this step, you will see the error message: "`target specifies product ty
 Run the following command to build a debug build with debugging symbols and assertions for iOS:
 
 ```
-`Tools/Scripts/build-webkit --debug --ios-simulator.`
+Tools/Scripts/build-webkit --debug --ios-simulator.
+```
+
+### Building GTK+ Port
+
+Install the dependencies by running the following command:
+```
+Tools/gtk/install-dependencies
 ```
 
-You can also change the default build configuration using the following commands:
+Then run the following command to build additional dependencies:
+```
+Tools/Scripts/update-webkitgtk-libs
+```
+
+Run the following command to build WebKit with debugging symbols for GTK+ port:
 
 ```
-`Tools/Scripts/set-webkit-configuration --debug
-Tools/Scripts/set-webkit-configuration --release`
+Tools/Scripts/build-webkit --debug --gtk
 ```
 
+Note that the procedure for building a release tarball is different.
+For more information, see the [wiki page](https://trac.webkit.org/wiki/BuildingGtk).
+
+### Building Windows Port
+
+For building WebKit on Windows, see the [wiki page](https://webkit.org/webkit-on-windows/).
+
 ## Running WebKit
 
 ### With Safari and Other macOS Applications
@@ -104,7 +117,7 @@ Tools/Scripts/set-webkit-configuration --release`
 Run the following command to launch Safari with your local build of WebKit:
 
 ```
-`Tools/Scripts/run-safari --debug`
+Tools/Scripts/run-safari --debug
 ```
 
 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`.
@@ -112,7 +125,7 @@ The `run-safari` script sets the `DYLD_FRAMEWORK_PATH` environment variable to p
 To run other applications with your local build of WebKit, run the following command:
 
 ```
-`Tools/Scripts/run-webkit-app <application-path>`
+Tools/Scripts/run-webkit-app <application-path>
 ```
 
 ### iOS Simulator
@@ -120,7 +133,7 @@ To run other applications with your local build of WebKit, run the following com
 Run the following command to launch iOS simulator with your local build of WebKit:
 
 ```
-`run-safari --debug --ios-simulator`
+run-safari --debug --ios-simulator
 ```
 
 In both cases, if you have built release builds instead, use `--release` instead of `--debug`.