Change README from rst to md.

This is necessary to have a proper project
description with build instructions on
the gitorious page.
Other websites use rst, but it seems that
gitorious only supports md.

Change-Id: I5a987bca9a61e025f0ba81bb93ad2b9265a119b2
Reviewed-by: Andras Becsi <andras.becsi@digia.com>

1 files changed, 69 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 000000000..61905d528
--- /dev/null
+++ b/README.md
@@ -0,0 +1,69 @@
+# QtWebEngine - Combining the power of Chromium and Qt #
+
+
+To be able to build QtWebEngine you need Qt5 or newer.
+
+## Build Instructions##
+### (1) Clone the QtWebEngine repository ###
+
+    git clone git://gitorious.org/qt-labs/qtwebengine.git
+
+### (2) Initialize the repository ###
+
+This will clone a submodule called 3rdparty that contains a snapshot of chromium sources.
+In case that any patches are necessary on top of the regular chromium sources,
+they will already be included in this snapshot.
+
+    git submodule init && git submodule update --recursive
+
+### (3) Generate the ninja build files by running qmake. ###
+
+Use qmake -r to forcefully re-gyp (without relying on make to determine if it's necessary).
+
+    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)
+
+    make
+
+## Additional tips and tricks ##
+
+### Complete Upstream Chromium Checkout ###
+If you want to have a complete chromium checkout with the complete history instead of the snapshot,
+then do not run step (2). Instead just run the init-repository.py script.
+
+This will then create a complete ninja and chromium checkout in the subdirectory 3rdparty_upstream.
+qmake will automatically pickup the location and make use of the sources in the subsequent step (3) and (4).
+
+
+    ./init-repository.py
+
+### Use shared libraries instead of static ones ###
+Linking all the static libraries can be a slow and painful process when developing (especially with debug builds).
+Use of shared libraries can be enforced by setting the GYP_DEFINES environment variable, like so:
+
+
+    export GYP_DEFINES=component=shared_library
+
+  Or by using the include.gypi mechanism described below:
+
+### Compiler Warnings treated as Errors (-Werror) ###
+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"
+
+### Use external Chromium sources ###
+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.
+
+