summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorSarah Smith <sarah.j.smith@nokia.com>2011-10-06 14:11:56 +1000
committerQt by Nokia <qt-info@nokia.com>2011-10-06 06:31:47 +0200
commite0b4a781a738507ac3440e57a252083d4e403c48 (patch)
tree842a137a67462b0fc658377f168294f90fe83c93 /README
parentf9377ca9c534b846ad321f4bb26222a657004287 (diff)
Change the readme in line with qt4 README.
The README in the Qt4 master branch now mentions Qt5, so mention it here as well. Change-Id: I31ca3357e32ebb89723ce585997b2239d6a45add Reviewed-on: http://codereview.qt-project.org/6101 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Julian de Bhal <julian.debhal@nokia.com>
Diffstat (limited to 'README')
-rw-r--r--README35
1 files changed, 32 insertions, 3 deletions
diff --git a/README b/README
index 3785f56c2..7f3a86f9e 100644
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-This directory contains the Qt3D project:
+This directory contains the Qt3D project for Qt5:
* QtQuick3D QML bindings and
* Qt3D C++ APIs
@@ -6,8 +6,37 @@ This directory contains the Qt3D project:
Building QtQuick3D
==================
-Check the building instructions in doc/src/qt3d-building.qdoc also available
-online at: http://doc.qt.nokia.com/qt-quick3d-snapshot/qt3d-building.html
+Qt5 is a rapidly changing bleeding edge environment. This branch is our initial
+support for it and thus is also rapidly changing and bleeding edge.
+
+This branch is experimental, and unsupported. This information is provided for
+advanced use only.
+
+No guarantees about API stability or even if this works at all are supplied, use
+at your own risk.
+
+First fetch the Qt5 source tree and QtQuick3D qml2 branch:
+
+ cd ~/depot
+ git clone ssh://codereview.qt-project.org:29418/qt/qt5.git
+ cd qt5
+ ./init-repository --codereview-username <username> \
+ --module-subset=qtbase,qtsvg,qtdeclarative,qtscript,qttools,qtxmlpatterns,qtdoc,qlalr,qtrepotools,qtqa,qtlocation,qtquick3d
+ git submodule foreach "git fetch gerrit && git reset --hard gerrit/master"
+ cd qtquick3d
+ scp -p -P 29418 codereview.qt-project.org:hooks/commit-msg .git/hooks/
+ git fetch gerrit
+ git checkout --track -b qml2 gerrit/qml2
+
+If you are reading this file then somehow you probably already got this far anyway.
+
+Now build Qt5, which will also build QtQuick3D as a module:
+
+ cd ~/build
+ mkdir qt5
+ cd qt5
+ ~/depot/qt5/configure -nokia-developer -no-webkit -no-phonon -nomake tests \
+ -nomake demos -nomake examples -declarative -opengl -script -svg && make -j 4
Whats in QtQuick3D