summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorZeno Albisser <zeno.albisser@digia.com>2013-07-01 14:10:56 +0200
committerPierre Rossi <pierre.rossi@gmail.com>2013-07-01 14:37:44 +0200
commit2c17b45c3d3ffa5f1630218947d21d3fc086de20 (patch)
treea31fbb5e5039cebd3ed6ec27b4828af0f4bfe29a
parent02add3497f1a83672453a88bd72d623c67df8eda (diff)
Update the README file.
Change-Id: I66bd3d47cc7b96a172292f7c7e7c7617d7a61174 Reviewed-by: Pierre Rossi <pierre.rossi@gmail.com>
-rw-r--r--README.rst49
1 files changed, 25 insertions, 24 deletions
diff --git a/README.rst b/README.rst
index ce627e880..0f2ddc183 100644
--- a/README.rst
+++ b/README.rst
@@ -2,30 +2,27 @@ This is a prototype of allowing embedding Chromium/Blink into Qt.
-- Build instructions:
-(1) Get the Chromium source code, see instructions at http://www.chromium.org/blink/conversion-cheatsheet
- Currently this is a bit iffy due to the WebKit -> Blink transition, but this is what worked for me:
+(1) Clone the QtWebEngine repository
- * git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git
- * Add depot_tools to your PATH
- * ubuntu>$ sudo apt-get build-dep chromium-browser
- * fetch blink --nosvn=True
- * If that didn't do the trick, it should essentially boil down to running "gclient sync"
+ * git clone git://gitorious.org/qt-labs/qtwebengine.git
-(2) Apply the necessary patches (located in patches/ subdir) to chromium's source tree.
- We have a half-baked script that automates updating and patching, with a few limitations:
- 1. it has to be run from the patches subdir
- 2. the affected git repos have to be in a clean state regarding am and rebase (i.e. no rebase-apply directory)
+(2) Initialize the repository
-(3) (Re-)generating the ninja build files after changing a gyp file:
+ This will clone the chromium sources and apply some necessary patches on top.
+
+ * ./init-repository.py
+
+(3) Generate the ninja build files by running qmake.
- * set the CHROMIUM_SRC_DIR environment variable to point to /path/to/src/
- * Simply run qmake in the top-level directory (it will call ninja behind the scenes).
Use qmake -r to forcefully re-gyp (without relying on make to determine if it's necessary).
- * Release or debug builds can be obtained by running 'make release' or 'make debug' in the
- top level directory (only lib and process for now, and not so smart with dependencies)
+
+ * qmake
(4) build with make ;)
+ Release or debug builds can be obtained by running 'make release' or 'make debug' in the
+ top level directory (only lib and process for now, and not so smart with dependencies)
+
(5) Additional tweaks and tips:
* linking all the static librairies can be a slow and painful process when developing (especially with debug builds).
Use of shared librairies can be enforced by setting the GYP_DEFINES environment variable, like so:
@@ -35,12 +32,16 @@ This is a prototype of allowing embedding Chromium/Blink into Qt.
Or by using the include.gypi mechanism described below:
* On Linux you may get build errors due to -Werror. Create ~/.gyp/include.gypi with the following contents:
- {
- 'variables': {
- 'werror%': '',
- 'component%': 'shared_library',
- },
- }
-
- So afterwards you have to re-create the ninja files by running "qmake -r"
+ {
+ 'variables': {
+ 'werror%': '',
+ 'component%': 'shared_library',
+ },
+ }
+
+ So afterwards you have to re-create the ninja files by running "qmake -r"
+
+ * If you want to use external chromium sources instead of the submodule provided in the QtWebEngine repository,
+ you can export the CHROMIUM_SRC_DIR variable pointint to your source directory.
+