From b03fb03df383d63f25deb828a333db0939a4d2df Mon Sep 17 00:00:00 2001 From: Sarah Smith Date: Mon, 18 Apr 2011 15:02:59 +1000 Subject: Windows related doc fixes. Make the README point at the html docs. They have to be authoritative, since QtCreator users and Windows users will in general not see the README. Also add message about getting the release or debug version right. --- README | 35 ++++++++++++--------- .../images/build-qt3d-qtcreator-set-to-release.png | Bin 0 -> 21295 bytes doc/src/qt3d-building.qdoc | 13 +++++++- 3 files changed, 33 insertions(+), 15 deletions(-) create mode 100644 doc/src/images/build-qt3d-qtcreator-set-to-release.png diff --git a/README b/README index 39285ee0c..3e8bb203c 100644 --- a/README +++ b/README @@ -1,15 +1,17 @@ -This directory contains the QtQuick3D product tree derived from the Qt3D project. +This directory contains the Qt3D project: + * QtQuick3D QML bindings and + * Qt3D C++ APIs -Run qmake and then make to build it against Qt. As of 10 March 2011 it requires -version 4.7.x of Qt, built with OpenGL and declarative support. This is standard -for binary distributions of Qt. -As of 10 March 2011 this product tree is being ported to avoid the dependency -on private headers in Qt. If it fails to build against your version of Qt -try building it against a developer build from source. +Building QtQuick3D +================== -You will need to have built Qt with the "-opengl" option. Run "make install" -afterwards to install the plugins into your Qt build. +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 + + +Whats in QtQuick3D +================== Directory structure: @@ -23,16 +25,21 @@ src/imports/ util/ Various utilities that are useful when working with Qt3D. examples/ - Some examples of using the Qt3D library. + Some examples of using QtQuiick3D (QML bindings) and Qt3D (C++ API). demos/ - More complex demos of Qt3D, including QtQuick3D for integrating - Qt3D with the "Qt Quick" Declarative UI component of Qt 4.7. -tests/ - Unit tests for the Qt3D libraries. + Some more complex demos of using QtQuiick3D (QML bindings) and Qt3D (C++ API). +tests/auto/qml3d/ + Unit tests for the QtQuick3D bindings. +tests/auto/threed/ + Unit tests for the Qt3D C++ API doc/ Documentation. devices/symbian/ Symbian deployment file + +Documentation +============= + The documentation can be generated with "make docs". It will be placed into "doc/html" in the build directory. diff --git a/doc/src/images/build-qt3d-qtcreator-set-to-release.png b/doc/src/images/build-qt3d-qtcreator-set-to-release.png new file mode 100644 index 000000000..882a80d83 Binary files /dev/null and b/doc/src/images/build-qt3d-qtcreator-set-to-release.png differ diff --git a/doc/src/qt3d-building.qdoc b/doc/src/qt3d-building.qdoc index 8d46598b7..6ab2af91e 100644 --- a/doc/src/qt3d-building.qdoc +++ b/doc/src/qt3d-building.qdoc @@ -149,7 +149,18 @@ \c{jom} tool which you will already be using automatically, to see how many parallel jobs your build will use. - Ok, now hit the build button. + \image build-qt3d-qtcreator-set-to-release.png + + \bold{Special note for Windows} - make sure that the type of build matches the + Qt that you are building against. In the case of binary packages, and the Qt + that ships with the SDK these are binary release builds - so in those cases set + your Qt3D to a release build also. One way to tell that this has gone wrong is + that your Qt3D library will be called \c{Qt3Dd.dll} (note the lower case "d" + for debug) when your QtGui library is called \c{QtGui4.dll} (no lower case "d"). + + By default the Qt build system used by QtCreator will build Qt3D in debug mode. + + Ok, \b{now} hit the build button. \bold{Step 4} - Build QtQuick3D and run a test App. -- cgit v1.2.3