Refactoring: Pull all fullscreen code out of Document and into its own helper class
[WebKit-https.git] / ReadMe.md
index 1dcbbc6..a8d6957 100644 (file)
--- a/ReadMe.md
+++ b/ReadMe.md
@@ -8,7 +8,7 @@ Visit [WebKit Feature Status](https://webkit.org/status/) page to see which Web
 
 ## Trying the Latest
 
-[Downloading Safari Technology Preview](https://webkit.org/downloads/) to test the latest version of WebKit.
+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.
 
 ## Reporting Bugs
 
@@ -27,33 +27,34 @@ 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
+```
+
+or
+
+```
+git clone https://git.webkit.org/git/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).
 
 ### Checking out the Subversion Repository
 
-Run the following command to check out WebKit's subversion repository:
+If you don't want to use Git, 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
+### Building macOS Port
 
 Install Xcode and its command line tools if you haven't done so already:
 
@@ -63,23 +64,23 @@ 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.
 
 ### Using Xcode
 
-You can open `WebKit.xcworkspace` to build and debug WebKit within WebKit.
+You can open `WebKit.xcworkspace` to build and debug WebKit within Xcode.
 
 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:
 
 ```
- sudo Tools/Scripts/configure-xcode-for-ios-development
+sudo Tools/Scripts/configure-xcode-for-ios-development
 ```
 
 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`.
@@ -87,16 +88,51 @@ 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
 ```
 
-You can also change the default build configuration using the following commands:
+### Building the GTK+ Port
+
+For production builds:
 
 ```
-`Tools/Scripts/set-webkit-configuration --debug
-Tools/Scripts/set-webkit-configuration --release`
+cmake -DPORT=GTK -DCMAKE_BUILD_TYPE=RelWithDebInfo -GNinja
+ninja
+sudo ninja install
 ```
 
+For development builds:
+
+```
+Tools/gtk/install-dependencies
+Tools/Scripts/update-webkitgtk-libs
+Tools/Scripts/build-webkit --gtk --debug
+```
+
+For more information on building WebKitGTK+, see the [wiki page](https://trac.webkit.org/wiki/BuildingGtk).
+
+### Building the WPE Port
+
+For production builds:
+
+```
+cmake -DPORT=WPE -DCMAKE_BUILD_TYPE=RelWithDebInfo -GNinja
+ninja
+sudo ninja install
+```
+
+For development builds:
+
+```
+Tools/wpe/install-dependencies
+Tools/Scripts/update-webkitwpe-libs
+Tools/Scripts/build-webkit --wpe --debug
+```
+
+### 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 +140,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 +148,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,11 +156,21 @@ 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`.
 
+### Linux Ports
+
+If you have a development build, you can use the run-minibrowser script, e.g.:
+
+```
+run-minibrowser --debug --wpe
+```
+
+Pass one of `--gtk`, `--jsc-only`, or `--wpe` to indicate the port to use.
+
 ## Contribute
 
 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/).