summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordpope <daniel.pope@nokia.com>2012-03-22 12:51:17 +1000
committerQt by Nokia <qt-info@nokia.com>2012-03-26 06:34:02 +0200
commitb79e163fe021935d9690df551092e10dae5d70f5 (patch)
tree895f6b7ea059a7ee3aa6b372841b7f9cf9cea3f4
parent8df89bf2bf7d9882791d60dfb05c8e687d643dd5 (diff)
downloadqt3d-b79e163fe021935d9690df551092e10dae5d70f5.tar.gz
Update of screenshots for Qt3D Building Instructions.
Task-number: QTBUG-24465 Change-Id: I65efd41255e88b70ff9b89cbfd1519cd6bd4e01d Reviewed-by: Sarah Jane Smith <sarah.j.smith@nokia.com>
-rw-r--r--doc/src/images/build-qt3d-qtcreator-1.pngbin176557 -> 117807 bytes
-rw-r--r--doc/src/images/build-qt3d-qtcreator-2.pngbin188352 -> 113745 bytes
-rw-r--r--doc/src/images/build-qt3d-qtcreator-3.pngbin80302 -> 102705 bytes
-rw-r--r--doc/src/images/build-qt3d-qtcreator-4.pngbin196664 -> 54078 bytes
-rw-r--r--doc/src/images/build-qt3d-qtcreator-5.pngbin181923 -> 57820 bytes
-rw-r--r--doc/src/images/build-qt3d-qtcreator-6.pngbin187095 -> 121981 bytes
-rw-r--r--doc/src/images/build-qt3d-qtcreator-7.pngbin142962 -> 94345 bytes
-rw-r--r--doc/src/images/build-qt3d-qtcreator-8.pngbin145519 -> 106491 bytes
-rw-r--r--doc/src/images/build-qt3d-qtcreator-9.pngbin204220 -> 264647 bytes
-rw-r--r--doc/src/qt3d-building.qdoc96
10 files changed, 49 insertions, 47 deletions
diff --git a/doc/src/images/build-qt3d-qtcreator-1.png b/doc/src/images/build-qt3d-qtcreator-1.png
index 1e044c5b3..c81185856 100644
--- a/doc/src/images/build-qt3d-qtcreator-1.png
+++ b/doc/src/images/build-qt3d-qtcreator-1.png
Binary files differ
diff --git a/doc/src/images/build-qt3d-qtcreator-2.png b/doc/src/images/build-qt3d-qtcreator-2.png
index 962e1387c..78bbea3ec 100644
--- a/doc/src/images/build-qt3d-qtcreator-2.png
+++ b/doc/src/images/build-qt3d-qtcreator-2.png
Binary files differ
diff --git a/doc/src/images/build-qt3d-qtcreator-3.png b/doc/src/images/build-qt3d-qtcreator-3.png
index 02b077c0d..95ff3c000 100644
--- a/doc/src/images/build-qt3d-qtcreator-3.png
+++ b/doc/src/images/build-qt3d-qtcreator-3.png
Binary files differ
diff --git a/doc/src/images/build-qt3d-qtcreator-4.png b/doc/src/images/build-qt3d-qtcreator-4.png
index 171f98374..d30428701 100644
--- a/doc/src/images/build-qt3d-qtcreator-4.png
+++ b/doc/src/images/build-qt3d-qtcreator-4.png
Binary files differ
diff --git a/doc/src/images/build-qt3d-qtcreator-5.png b/doc/src/images/build-qt3d-qtcreator-5.png
index 89956c835..996d04cda 100644
--- a/doc/src/images/build-qt3d-qtcreator-5.png
+++ b/doc/src/images/build-qt3d-qtcreator-5.png
Binary files differ
diff --git a/doc/src/images/build-qt3d-qtcreator-6.png b/doc/src/images/build-qt3d-qtcreator-6.png
index 23eca7789..dabffb392 100644
--- a/doc/src/images/build-qt3d-qtcreator-6.png
+++ b/doc/src/images/build-qt3d-qtcreator-6.png
Binary files differ
diff --git a/doc/src/images/build-qt3d-qtcreator-7.png b/doc/src/images/build-qt3d-qtcreator-7.png
index aa88c4de7..e6d0a452e 100644
--- a/doc/src/images/build-qt3d-qtcreator-7.png
+++ b/doc/src/images/build-qt3d-qtcreator-7.png
Binary files differ
diff --git a/doc/src/images/build-qt3d-qtcreator-8.png b/doc/src/images/build-qt3d-qtcreator-8.png
index c6e6db9f1..0a050127c 100644
--- a/doc/src/images/build-qt3d-qtcreator-8.png
+++ b/doc/src/images/build-qt3d-qtcreator-8.png
Binary files differ
diff --git a/doc/src/images/build-qt3d-qtcreator-9.png b/doc/src/images/build-qt3d-qtcreator-9.png
index 8fce56ebd..befcce200 100644
--- a/doc/src/images/build-qt3d-qtcreator-9.png
+++ b/doc/src/images/build-qt3d-qtcreator-9.png
Binary files differ
diff --git a/doc/src/qt3d-building.qdoc b/doc/src/qt3d-building.qdoc
index 721596e60..e6b8359ca 100644
--- a/doc/src/qt3d-building.qdoc
+++ b/doc/src/qt3d-building.qdoc
@@ -60,8 +60,8 @@
\section1 Building Qt3D
- Qt3D requires Qt 5.0. The QtSDK currently ships with Qt 4.8 so you will need
- to \l{http://developer.qt.nokia.com/wiki/Building_Qt_5_from_Git}{build from Git}.
+ The latest version of Qt3D requires Qt 5.0. The QtSDK currently ships with Qt 4.8 so
+ you will need to \l{http://developer.qt.nokia.com/wiki/Building_Qt_5_from_Git}{build from Git}.
Just make sure that when you build Qt, that you use the
-developer-build option, and do not do a \c{make install} as root.
@@ -69,13 +69,25 @@
headers and plugins into the correct position in the hosted Qt library,
so that will need to be writable.
+ If you're working with Qt4.8.x, and want to use Qt3D, you will need to check-out the
+ qt4 branch for Qt3D. After the git clone command earlier, checkout the qt4 code branch
+ by running:
+
+ \code
+ $ git checkout --track -b qt4 origin/qt4
+ \endcode
+
+ Instructions for building against Qt4 are fundamentally the same as for Qt5 (except that
+ wherever we select Qt5 in these instructions, you should use Qt4.8), however
+ you should make and review the docs provided in the qt4 branch for accuracy.
+
\section1 Building Qt3D Using QtCreator / QtSDK
Here is a step-by-step guide to building Qt3D using the
\l{http://qt.nokia.com/products/appdev/developer-tools/developer-tools}{QtCreator IDE}.
- QtCreator is the development environment for the QtSDK. Here we're using
- version 2.0 on Mac OSX, but other operating systems and versions should
- look similar. Always use the latest release of QtCreator if possible.
+ QtCreator is the development environment for the QtSDK. As you can see in the screenshot
+ below, we're using the beta version 2.5 on Linux, but other operating systems and
+ versions should look similar. Always use the latest release of QtCreator if possible.
\image build-qt3d-qtcreator-1.png
@@ -88,55 +100,43 @@
\bold{Step 2} - Select the Qt and load Qt3D.
- \image build-qt3d-qtcreator-4.png
-
- Set the Qt5 build that you created above. In this screenshot there is a
- situation where I have a large number of Qt versions to choose from, so it is
- easiest to use the "Uncheck All" button, then check the one I want - which is the
- Qt created above. You'll need to add it using the "Manage" button first.
-
\image build-qt3d-qtcreator-3.png
- After a short time QtCreator will have loaded up the Qt3D project, read all its
- project files and display the source tree as shown just above.
-
- \bold{Step 2a} - Useful Options
+ Set the Qt5 build that you created above. In the screenshot below there is a
+ situation where we have a number of Qt versions to choose from, so it is
+ easiest to uncheck all of the ones we don't need, then check the one we want - which
+ is the Qt5 version created above. You may need to add it using the "Manage" button first.
- Use \c{QtCreator} -> \c{Preferences...} to bring up QtCreators options and settings.
- On Windows its \c{Tools} -> \c{Options...}.
-
- Make sure you have QtCreator set to display the compile process, so you can check
- what any errors may be. The other options are set how I like them, and may suit
- your use too. Give them a try, as shown in this screenshot just below.
+ After a short time QtCreator will have loaded up the Qt3D project, read all its
+ project files and display the source tree as shown below.
- \image build-qt3d-qtcreator-7.png
+ \image build-qt3d-qtcreator-4.png
\bold{Step 3} - Set up for Building.
+ Click the projects tab at the left to display the Qt3D target's \c{Build Settings}
+ pane, marked in the screenshot below.
+
\image build-qt3d-qtcreator-5.png
- Click the projects tab at the left to display the Qt3D target's \c{Build Settings}
- pane. Here you can specify a Shadow Build directory. It is always a good idea to
+ Here you can specify a Shadow Build directory. It is always a good idea to
build in a shadow directory, instead of inside the source tree.
- In the screenshot just above I use the Finder (Mac's equivalent to the Windows File
- Manager) to create the shadow build directory as a "new folder".
+ In the screenshot below we use file management windows invoked by the the browse button to create
+ the shadow build directory as a "new folder", which we'll call "qt3d" to match the project name.
\image build-qt3d-qtcreator-6.png
- In this screenshot, I have renamed the "new folder" to match the shadow build directory
- name that I gave QtCreator. Now I'm ready to click the "Build" button - circled in
- red in the bottom left hand corner of Qt Creators main screen.
+ Here's another handy trick - set QtCreator to use multiple cores when it builds, if its supported
+ on your platform. On Mac and other platforms that use GCC I can set the \c{-j 4} argument to \c{make}.
- \image build-qt3d-qtcreator-8.png
+ Do this by expanding the details of the make step in the projects page, then enter the extra arguments,
+ as shown below.
- Before you do that here's a handy trick - set QtCreator to use multiple cores
- when it builds, if its supported on your platform. On Mac and other platforms that
- use GCC I can set the \c{-j 4} argument to \c{make}. For Windows check for the
- \c{jom} tool which you will already be using automatically, to see how many
- parallel jobs your build will use.
+ \image build-qt3d-qtcreator-7.png
- \image build-qt3d-qtcreator-set-to-release.png
+ For Windows check for the \c{jom} tool which you will already be using automatically, to see how many
+ parallel jobs your build will use.
\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
@@ -145,11 +145,15 @@
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").
+ \image build-qt3d-qtcreator-set-to-release.png
+
+ \bold{Step 4} - Build Qt3D and run a test App.
+
By default the Qt build system used by QtCreator will build Qt3D in debug mode.
- Ok, \bold{now} hit the build button.
+ Now hit the build button (marked with a red arrow in the screenshot below)
- \bold{Step 4} - Build Qt3D and run a test App.
+ \image build-qt3d-qtcreator-8.png
Qt3D will go ahead and compile all its libraries, plugins and QML imports.
@@ -179,13 +183,11 @@
There is no need to run a make install step.
- \image build-qt3d-qtcreator-9.png
-
- Now you can use QtCreator to run one of the examples. Click the button for the
- project switcher (circled in red) and then choose one of the apps. Here we
- have chosen the QML "Moon" app from the menu (indicated by the red arrow).
+ Now you can use QtCreator to run one of the examples. You can do this by right clicking on
+ the example you want to run in the build tree (in this case, the "basket" app), then clicking
+ the green arrow bottom to actually launch the app.
- Click the green arrow bottom left to actually launch the "Moon" app.
+ \image build-qt3d-qtcreator-9.png
Congratulations on building Qt3D!
@@ -198,7 +200,7 @@
$ cd $HOME/build/qt5
$ make module-qt3d
$ make -j 4
- $ bin/moon
+ $ bin/basket
\endcode
Note that the \c{$} above means the shell prompt (don't type the \{$}).
@@ -211,7 +213,7 @@
\code
cd \build\qt5
nmake module-qt3d
- bin\moon
+ bin\basket
\endcode
These commands for Windows assume that your Qt build for Qt5 is in