Ensure that qmake doesn't lose the error code when processing subdirs
[qt-netbsd.git] / README.s60
blob2137135d034fa8ba72699c7b284aec243b3b1f07
1 This is Qt version %VERSION%.
3 Qt is a comprehensive cross-platform C++ application framework. With
4 this pre-release you can make advanced graphical applications and
5 utilize TCP/IP connections. More specifically, these modules are now
6 available for S60:
8 QtCore    - http://doc.trolltech.com/4.6-snapshot/qtcore.html
9 QtGui     - http://doc.trolltech.com/4.6-snapshot/qtgui.html
10 QtNetwork - http://doc.trolltech.com/4.6-snapshot/qtnetwork.html
11 QtScript  - http://doc.trolltech.com/4.6-snapshot/qtscript.html
12 QtSql     - http://doc.trolltech.com/4.6-snapshot/qtsql.html
13 QtSvg     - http://doc.trolltech.com/4.6-snapshot/qtsvg.html
14 QtTest    - http://doc.trolltech.com/4.6-snapshot/qttest.html
15 QtWebKit  - http://doc.trolltech.com/4.6-snapshot/qtwebkit.html
16 QtXml     - http://doc.trolltech.com/4.6-snapshot/qtxml.html
17 Phonon    - http://doc.trolltech.com/4.6-snapshot/phonon-module.html
19 INSTALLING Qt
21 Follow the instructions in the INSTALL file.
23 REFERENCE DOCUMENTATION
25 The Qt reference documentation is available locally in Qt's doc/html
26 directory or at http://doc.trolltech.com/4.6-snapshot/index.html
28 SUPPORTED PLATFORMS
30 For this release, the following platforms have been tested:
32    S60 3.1, 3.2 and 5.0
33   
34 with these compilers:
36    WINSCW (Emulator, X86)
37    RVCT (Hardware, ARM)
38    GCCE (Hardware, ARM)*
40 The current version of GCCE cannot compile the Qt libraries
41 themselves as it has issues with global static data in DLLs.
42 However, we supply precompiled Qt libraries compiled with RVCT
43 that can be used instead. This makes it possible to write and
44 compile Qt applications using GCCE by linking to these
45 precompiled binaries. For more information on this issue see:
46 http://www3.symbian.com/faq.nsf/0/B8542F039C193CCC802573DA0011DFA7
48 HOW TO REPORT A BUG
50 We have set up a special mailinglist for feedback on the S60 port.
51 Bug-reports, feedback or questions all go to this list.
52 Please go to http://pepper.troll.no/s60prereleases/ 
53 for details on how to subscribe to the list.
55 Before posting, please consult the FAQ and the list of known issues:
56 http://labs.trolltech.com/page/QtforS60FAQ
57 http://labs.trolltech.com/page/QtforS60KnownIssues
59 Always include the following information in your bug report: the name
60 and version number of your compiler; the name and version number of
61 your operating system; the version of Qt you are using, and what
62 configure options it was compiled with.
64 If the problem you are reporting is only visible at run-time, try to
65 create a small test program that shows the problem when run. Often,
66 such a program can be created with some minor changes to one of the
67 many example programs in Qt's examples directory.
70                    INSTALLING Qt for S60 Version %VERSION%
72 1.  Install needed IDE and SDKs
74     Make sure you have the following installed:
75     
76     - Carbide.c++ v2.0.0 or higher: 
77       http://www.forum.nokia.com/main/resources/tools_and_sdks/carbide_cpp/
78      
79       Note: It may be necessary to update the Carbide compiler. 
80             See http://pepper.troll.no/s60prereleases/patches/ for instructions 
81             how to check your compiler version and how to patch it, if needed.
82     
83     - S60 Platform SDK 3rd Edition FP1 or higher: 
84       http://www.forum.nokia.com/main/resources/tools_and_sdks/S60SDK/
85     
86     - Open C/C++ v1.6.0 or higher. Install this to all S60 SDKs you plan to use Qt with:
87       http://www.forum.nokia.com/main/resources/technologies/openc_cpp/
88     
89     - Building Qt tools requires a windows compiler, e.g. MinGW 3.4.5 or higher.
90       http://www.mingw.org/
91     
92     - Building Qt libraries for real device requires RVCT 2.2 [build 686] or later:
93       http://www.arm.com/products/DevTools/RVCT.html
94     
95     Make sure you have the following packages installed on any device you want to use to
96     run Qt applications. These packages can be found under nokia_plugin directory in any 
97     S60 SDK where you have installed Open C/C++:
98     
99     - nokia_plugin\openc\s60opencsis\pips_s60_<version>.sis
100     - nokia_plugin\openc\s60opencsis\openc_ssl_s60_<version>.sis
101     - nokia_plugin\opencpp\s60opencppsis\stdcpp_s60_<version>.sis
103     These instructions assume the above tools are installed and
104     that the enviroment variables for your compiler are set correctly.
106     Note: Users of S60 Platform SDK 3rd Edition FP1 also need special updates:
107           http://pepper.troll.no/s60prereleases/patches/
109 2.  Install Qt
111     Uncompress the package into the directory you want Qt installed,
112     e.g. C:\Qt\%VERSION%. 
114     Note: Qt must be installed on the same drive as the S60 SDK you are
115     using, and the install path must not contain any whitespaces.
117 3.  Environment variables
119     In order to build and use Qt, the PATH environment variable needs
120     to be extended:
122         PATH               - to locate qmake, moc and other Qt tools
124     This is done by adding c:\Qt\%VERSION%\bin to the PATH variable.
126     On Windows the PATH can be extended by navigating to
127     "Control Panel->System->Advanced->Environment variables".
129     In addition, you must configure the environment for use with the S60
130     emulator. This is done by locating the Carbide.c++ submenu on the Start
131     menu, and choosing "Configure environment for WINSCW command line".
133 4.  Configure Qt
135     To configure Qt for S60, do:
137         cd \Qt\%VERSION%
138         configure -platform win32-g++ -xplatform symbian-abld
140     For other options, type "configure -help" to get a list of all available
141     options.
143 5.  Build Qt
145     To build Qt for the emulator, type:
147         make debug-winscw
149     To build Qt for the device, type:
151         make release-armv5
153     Congratulations, Qt is now ready to use.
155 6.  Running Qt demos
157     We've included a subset of the Qt demos in this package for you to try out. 
158     An excellent starting point is the "fluidlauncher" demo. To run the demo on 
159     a real device, you first have to install the Qt libraries on the device:
161         cd src\s60installs
162         createpackage -i Qt_for_S60_template.pkg release-armv5 <certificate file> <certificate key file>
164     Note: You will need to supply certificate that allows installation of 
165           binaries with "All -Tcb" capability to your device.
167     Similarly, install fluidlauncher to the device:
169         cd embedded\fluidlauncher
170         createpackage -i fluidlauncher_template.pkg release-armv5
172     This will create a self-signed fluidlauncher_release-armv5.sis and install it to your device.
174     To run the demos on the emulator simply navigate to the directory of the demo and run:
176         make run
178     Or, if you need to supply arguments to the program, navigate to 
179     %EPOCROOT%\Epoc32\release\winscw\udeb\ and start any of the Qt demos located there,
180     for example:
182         wiggly.exe -small-screen
184     We hope you will enjoy using Qt.