Start on Creating Plugins documentation.

Change-Id: Ic75775473cfb405cee5c53b2dc24144dba51a25c
Reviewed-by: Leena Miettinen <[email protected]>

1 files changed, 100 insertions, 0 deletions

diff --git a/doc/api/getting-and-building.qdoc b/doc/api/getting-and-building.qdoc
new file mode 100644
index 00000000000..35a6da76595
--- /dev/null
+++ b/doc/api/getting-and-building.qdoc
@@ -0,0 +1,100 @@
+/****************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
+**
+** Contact: Nokia Corporation ([email protected])
+**
+**
+** GNU Free Documentation License
+**
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of this
+** file.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at [email protected].
+**
+****************************************************************************/
+
+/*!
+    \page getting-and-building.html
+    \title Getting and Building Qt Creator
+
+    \code
+    TODO: This should be extended.
+    * How to avoid building Qt
+    * Windows specific hassle, see README in \QC sources
+    \endcode
+
+    There are several reasons why you might want to do your own build of \QC,
+    like using the most current development version and being able to tweak
+    \QC at one or the other place. It is also necessary if you want to
+    create your own \QC plugin.
+
+    \section1 Getting and Building Qt
+
+    \QC usually uses the latest stable release of Qt,
+    you can see the exact minimum requirement at the top of \QC's qtcreator.pro.
+    (You can find the current version in our source repository here:
+    \l{https://qt.gitorious.org/qt-creator/qt-creator/blobs/master/qtcreator.pro}.)
+
+    You find the sources for the different Qt versions for example on our gitorious repository
+    \l{http://qt.gitorious.org/qt}.
+
+    \QC requires private headers of Qt, which are unfortunately not installed
+    by the Qt binary packages, and also are not copied to the installation directory when
+    using \c{make install} on a self-compiled Qt. To solve this problem
+    configure Qt with the \c{-developer-build} option, which sets the install
+    directory to the build directory itself (you are not required to run
+    \c{make install} in that case).
+    In Linux and Mac terminals, enter the following commands:
+    \code
+    cd <QtSources>
+    ./configure -developer-build
+    make
+    \endcode
+    On Windows, open a command prompt where your developer tools are set up, and enter
+    the following commands for MSVC builds
+    \code
+    cd <QtSources>
+    configure -developer-build
+    nmake
+    \endcode
+
+    If you really need to use a Qt build that does not have private headers in its
+    installation directory, you can set the \c{QT_PRIVATE_HEADERS} qmake variable
+    to the include path which contains them, when running qmake on the \QC
+    sources (see below).
+
+    \section1 Getting and Building \QC
+
+    You can get the \QC sources for a specific version either by using one of the
+    released source bundles, or from the Gitorious repository
+    \l{http://qt.gitorious.org/qt-creator}. If you intend to contribute to \QC
+    itself, you should use the repository from our Gerrit review tool as described
+    in the developer wiki here: \l{http://wiki.qt-project.org/Setting_up_Gerrit}.
+
+    We strongly encourage you to do out-of-source builds of \QC (also called
+    shadow-builds).
+    After you put the \QC sources somewhere (lets call the path \c{<QtCreatorSources>})
+    you build it on Linux and Mac with
+    \code
+    cd <QtCreatorSources>/..
+    mkdir qtcreator-build
+    cd qtcreator-build
+    <QtInstall>/bin/qmake -r <QtCreatorSources>
+    make
+    \endcode
+    or the corresponding commands on Windows systems.
+
+    If your Qt installation does not contain private headers (see above), you can point \QC
+    to the private headers by setting the \c{QT_PRIVATE_HEADERS} qmake variable
+    to the include directory that contains them. On Linux and Mac, enter the following command
+    instead of the qmake call above:
+    \code
+    <QtInstall>/bin/qmake -r QT_PRIVATE_HEADERS=<QtSources>/include <QtCreatorSources>
+    \endcode
+*/