doc/src/platforms/s60-introduction.qdoc
changeset 0 1918ee327afb
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/src/platforms/s60-introduction.qdoc	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,152 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \page symbian-with-qt-introduction.html
+
+    \title Symbian platform - Introduction to using Qt
+    \brief An introduction to Qt for Symbian platform developers.
+    \ingroup howto
+    \ingroup qts60
+
+    \tableofcontents
+
+    \section1 Required tools
+
+    See \l{Qt for Symbian platform Requirements} to see what tools are
+    required to use Qt for Symbian platform.
+
+    \section1 Installing Qt and running demos
+
+    Follow the instructions found in \l{Installing Qt on the Symbian platform using binary package} to learn how
+    to install Qt using binary package and how to build and run Qt demos.
+
+    Follow the instructions found in \l{Installing Qt on the Symbian platform} to learn how to install Qt using
+    using source package and how to build and run the Qt demos.
+
+    \section1 Building your own applications
+
+    If you are new to Qt development, have a look at \l{How to Learn Qt}. 
+    In general, the difference between developing a
+    Qt application on the Symbian platform compared to any of the other platforms supported
+    by Qt is not that big.
+
+    Once you have created a \c .pro file for your project, generate the
+    Carbide specific \c Bld.inf and \c .mmp files this way:
+
+    \snippet doc/src/snippets/code/doc_src_s60-introduction.qdoc 0
+
+    For more information on how to use qmake have a look at the \l
+    {qmake Tutorial}.
+
+    Now you can build the Qt for the Symbian platform application with
+    standard build tools. By default, running \c make will produce binaries for
+    the emulator. However, the Symbian platform comes with several alternative
+    build targets, as shown in the table below:
+
+    \table
+    \row \o \c debug-winscw  \o Build debug binaries for the emulator (default).
+                                It is currently not possible to build release
+                                binaries for the emulator.
+    \row \o \c debug-gcce    \o Build debug binaries for hardware using GCCE.
+    \row \o \c release-gcce  \o Build release binaries for hardware using GCCE.
+    \row \o \c debug-armv5   \o Build debug binaries for hardware using RVCT.
+    \row \o \c release-armv5 \o Build release binaries for hardware using RVCT.
+    \row \o \c run           \o Run the emulator binaries from the build directory.
+    \row \o \c sis           \o Create signed \c .sis file for project.
+    \endtable
+
+    The following lines perform a debug build for the emulator
+    and deploy all the needed files:
+
+    \snippet doc/src/snippets/code/doc_src_s60-introduction.qdoc 1
+
+    To work on your project in Carbide, simply import the \c .pro file
+    by right clicking on the project explorer and executing "Import...".
+
+    \section1 Installing your own applications
+
+    To install your own applications on hardware, you need signed \c .sis file.
+    The signed \c .sis file can be created with \c make \c sis target. \c sis target
+    is only supported for executables or projects with \c DEPLOYMENT statements.
+    By default the \c sis target will create signed \c .sis file for last build
+    target. For example, the following sequence will generate the needed makefiles, 
+    build the project for \c debug-winscw and \c release-armv5, and create 
+    self-signed \c .sis file for \c release-armv5 target:
+
+    \snippet doc/src/snippets/code/doc_src_s60-introduction.qdoc 2
+
+    If you want to use different certificate information or override the default
+    target for \c .sis file creation you can use the environment variables as 
+    shown in the table below:
+
+    \table
+    \row \o \c QT_SIS_OPTIONS      \o Options accepted by \c .sis creation. 
+                                       -i, install the package right away using PC suite.
+                                       -c=<file>, read certificate information from a file.
+                                       Execute the \c{createpackage.pl} script without any 
+                                       parameters for more information about options.
+                                       By default no otions are given.
+    \row \o \c QT_SIS_TARGET       \o Target for which \c .sis file is created.
+                                       Accepted values are build targets listed in 
+                                       previous table. By default last build target.
+    \row \o \c QT_SIS_CERTIFICATE  \o The certificate file used for signing.
+                                       By default self-signed certificate. 
+    \row \o \c QT_SIS_KEY          \o The certificate's private key file.
+                                       By default key is associated to self-signed certificate. 
+    \row \o \c QT_SIS_PASSPHRASE   \o The certificate's private key file's passphrase.
+                                       By default empty. 
+    \endtable    
+
+    For example:
+
+    \snippet doc/src/snippets/code/doc_src_s60-introduction.qdoc 4        
+
+    The environment variables for \c make can also be given as parameters:
+
+    \snippet doc/src/snippets/code/doc_src_s60-introduction.qdoc 3        
+
+    If you want to install the program immediately, make sure that the device
+    is connected to the computer in "PC Suite" mode, and run \c sis target
+    with the \c QT_SIS_OPTIONS=-i, like this:
+
+    \snippet doc/src/snippets/code/doc_src_s60-introduction.qdoc 5
+*/