summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorOswald Buddenhagen <oswald.buddenhagen@nokia.com>2012-04-23 20:38:41 +0200
committerQt by Nokia <qt-info@nokia.com>2012-06-28 03:14:24 +0200
commitbb6251a7a0e1ff7d0c628a6e3420bf7bac59cfdb (patch)
tree51b1860a3703c1478e7bc8edc7b16b08ec720934 /README
parenta4628855ee95ef359e3ea66fcdb47dc03f14a9c4 (diff)
revamp the build/install targets of auxilliary files
files will now always be copied to the build dir, and install targets will be created always as well. Change-Id: I42a57d7fb6536ec3e5ade088f02872484891507e Reviewed-by: Sarah Jane Smith <sarah.j.smith@nokia.com>
Diffstat (limited to 'README')
-rw-r--r--README50
1 files changed, 12 insertions, 38 deletions
diff --git a/README b/README
index f304eef07..0b5cc8dd5 100644
--- a/README
+++ b/README
@@ -81,44 +81,18 @@ This section is only for those developing Qt3D. Read on to discover how
the building of packages works. This section is also important if you want to
change how the structure of the Qt3D pro files work.
-Qt3D is intended to be built in one of two ways:
-
-1) Normal developer way:
- qmake && make
-2) Package creation way:
- qmake CONFIG+=package && INSTALL_ROOT=tmp make install
-
-In 1) the .pro files will cause the toolchain to place the libraries, plugins
-header files and other components of Qt3D directly into place, as part of
-the compile process. What does "in place" mean? Run "qmake -query" to see
-the paths where the files are placed - QML plugins go in $$[QT_INSTALL_IMPORTS]
-for example. In this mode, there is no need to run "make install" because the
-files are already in their target destination. Here the "target destination"
-means the Qt which is being built against.
-
-First note that Qt3D has to be installed into the target Qt. This is because
-Qt3D has QML plugins and resources, as well as shared libraries, all of which
-must be resolved by the QMLViewer of the target Qt at runtime. Here where "qmake"
-is referred to it means the qmake inside the target Qt. Since QtQml
-recommends using QMLViewer when developing and debugging QML Apps, in the developer
-case - which is what Qt3D is for - it has to install directly into the target Qt.
-
-In this mode 1) after the main library is compiled subsequent targets can simply
-resolve includes and link time dependencies by use of qt3d.prf and qtquick3d.prf.
-These two files are installed into the target Qt's makespecs/features directory
-during the processing of the qt3d.pro file.
-
-In 2) the libraries, plugins and so on are sitting inside the build tree after
-the compile step. As a result in order to resolve includes and dependencies
-the build system has to navigate the build tree with paths like "-L../../../threed"
-to locate the Qt3D libraries.
-
-Actually there is one build artifact that is not just left where it lands in the
-build tree - the header files. These are actually copied into an "include"
-directory inside the build root directory. This is because at present the header
-files all live inside their own seperate subdirectories under "threed" and would
-be too cumbersome to path in explicitly.
+To build Qt3D, run:
+
+ qmake && make
+
+The .pro files will cause the toolchain to place the libraries, QML files and
+meshes of Qt3D directly into place, as part of the compile process. The files
+go into the bin/ directory, and the executables can be run directly from there.
+If you are doing a developer build, plugins will be installed in such a way
+that Qt will find them.
After building the tree the install step is invoked using the INSTALL_ROOT environment
export to cause the installation rules to place all the files into a sandboxed
-install tree, ready for packaging.
+install tree, ready for packaging:
+
+ INSTALL_ROOT=tmp make install