source: tspsg-svn/trunk/INSTALL.txt @ 134

Last change on this file since 134 was 134, checked in by laleppa, 14 years ago
  • The minimum required version of Qt is now 4.5.0.
  • Updated source code to be compatible with the minimum required version of Qt.
  • Updated documentation to reflect these changes.
File size: 8.4 KB
Line 
1==========================
2 TSPSG Installation Guide
3==========================
4
5Thank you for trying TSPSG. This document will guide you through the
6steps necessary to compile and run TSPSG.
7
8TABLE OF CONTENTS:
9
10  1. REQUIREMENTS
11  2. ASSUMPTIONS
12  3. SUPPORTED PLATFORMS
13  4. BUILDING AND INSTALLATION
14     4.1. GENERAL PROCEDURE
15     4.2. LINUX/UNIX
16     4.3. WINDOWS
17          4.3.1. USING MINGW
18          4.3.2. USING VISUAL STUDIO
19     4.4. WINDOWS MOBILE
20     4.5. SYMBIAN
21     4.6. OTHER PLATFORMS, SUPPORTED BY QT
22  5. UNINSTALLATION
23  6. TROUBLESHOOTING
24     6.1. WINDRES.EXE CRASH
25  7. NOTES
26  8. REFERENCES
27
28
29
301. REQUIREMENTS
31===============
32
33To be able compile TSPSG you need to have Qt libraries. The minimum
34supported version of Qt is 4.5.0. The recommended version is 4.6.x
35or higher.
36
37NOTE: Please, note that there will be some regressions in functionality
38if your version of \em Qt is lower than the recommended.
39
40
41
422. ASSUMPTIONS
43==============
44
45This guide assumes that you already have Qt libraries and all necessary
46prerequisites installed.
47
48Also, the following assumptions are made:
49
50  - For Linux/UNIX: lrelease and qmake are avilable in $PATH.
51
52  - For Windows (minGW) and Symbian: you have installed Qt SDK or
53    prebuilt libraries and have Start Menu items for Qt tools.
54
55  - For Windows (Visual Studio) and Windows Mobile: the Qt libraries
56    reside in C:\Qt\.
57
58  - For Windows Mobile: Windows Mobile 5.0 Pocket PC SDK or later is
59    installed.
60
61
62
633. SUPPORTED PLATFORMS
64======================
65
66TSPSG is oficially supported and tested on the following platforms:
67
68  - Linux: Gentoo AMD64 and Kubuntu 9.10 64-bit AMD.
69
70  - Windows: Windows XP 32-bit and Windows 7 64-bit.
71
72  - Windows Mobile: Windows Mobile 6.5 Professional Edition.
73
74
75
764. BUILDING AND INSTALLATION
77============================
78
794.1 GENERAL PROCEDURE
80
81On most platforms the general building and installation procedure is:
82
83  1. Run lrelease to generate binary translation files (.qm) from the
84     source (.ts).
85
86  2. Run qmake with CONFIG+=release parameter to generate makefiles.
87
88  3. Run make utility (e.g., make, nmake, mingw32-make) to build TSPSG.
89
90  4. Run make utility with 'install' parameter (without quotes).
91
92NOTE: It is important to run lrelease before qmake, or qmake will not
93"pick up" the translations when generating installation rules.
94
95
964.2. LINUX/UNIX
97---------------
98
99Open a shell, navigate to the directory where you have TSPSG source
100downloaded and type
101
102    tar xvjf tspsg-<VERSION>-src.tar.bz2
103    cd tspsg-<VERSION>-src
104
105where <VERSION> is the version of TSPSG you downloaded. Now run
106
107    lrelease tspsg.pro
108    qmake tspsg.pro
109    make
110
111In some cases you may need to type
112
113    qmake tspsg.pro CONFIG+=release
114
115
116If make step finished without errors you can install TSPSG by running
117
118    sudo make install
119
120or
121
122    su
123    make install
124
125depending on your distribution.
126
127By default, executable will go to /usr/bin, COPYING and README will go
128to /usr/share/TSPSG, translations will go /usr/share/TSPSG/l10n, docs
129will go to /usr/share/doc/TSPSG-<VERSION>.
130
131
1324.3. WINDOWS
133------------
134
135NOTE: Please, read the Section 7 after reading this Section.
136
1374.3.1. USING MINGW
138~~~~~~~~~~~~~~~~~~
139
140Unpack the downloaded source code of TSPSG with your favourite
141compression software. Now launch the Qt Command Prompt from the Start
142Menu, navigate to the directory where you unpacked the source and run
143
144    lrelease tspsg.pro
145    qmake tspsg.pro CONFIG+=release
146    mingw32-make
147
148NOTE: Make process may fail with a crash of windres.exe. If you've run
149into this issue, please, read the Section 6.1.
150
151If make step finished without errors you can install TSPSG by running
152
153    mingw32-make install
154
155TSPSG will be installed to %PROGRAMFILES%\TSPSG folder (usually, it is
156C:\Program Files\TSPSG).
157
158
1594.3.2. USING VISUAL STUDIO
160~~~~~~~~~~~~~~~~~~~~~~~~~~
161
162Unpack the downloaded source code of TSPSG with your favourite
163compression software. Now launch the Visual Studio Command Prompt from
164the Start Menu, navigate to the directory where you unpacked the source
165and run
166
167    C:\Qt\bin\lrelease tspsg.pro
168    C:\Qt\bin\qmake tspsg.pro CONFIG+=release
169    nmake
170
171If make step finished without errors you can install TSPSG by running
172
173    nmake install
174
175TSPSG will be installed to %PROGRAMFILES%\TSPSG folder (usually, it is
176C:\Program Files\TSPSG).
177
178
1794.4. WINDOWS CE/MOBILE
180----------------------
181
182Unpack the downloaded source code of TSPSG with your favourite
183compression software. Now launch the Visual Studio Command Prompt from
184the Start Menu and run
185
186    set PATH=C:\Qt\bin;%PATH%
187    setcepaths wincewm50pocket-msvc2008
188
189Now navigate to the directory where you unpacked the source and run
190
191    lrelease tspsg.pro
192    qmake tspsg.pro CONFIG+=release
193    nmake
194
195There is no automated installation process for Windows Mobile build. To
196install TSPSG on your PDA you need to create a folder on your device
197and copy the following files to it:
198
199  - tspsg.exe from release folder in the source directory.
200
201  - QtCore4.dll and QtGui4.dll from C:\Qt\bin folder.
202
203  - msvcr90.dll from
204    C:\Program Files\Microsoft Visual Studio 9.0\VC\ce\dll\armv4i folder.
205
206  - all *.qm files from l10n folder in the source directory to l10n
207    subfolder.
208
209
2104.5. SYMBIAN
211------------
212
213Unpack the downloaded source code of TSPSG with your favourite
214compression software. Now launch the Qt for Symbian Command Prompt from
215the Start Menu, navigate to the directory where you unpacked the source
216and run
217
218    lrelease tspsg.pro
219    qmake tspsg.pro CONFIG+=release
220    make release-gcce
221
222WARNING: You need to unpack the source to the same drive as Symbian SDK
223and the path must not contain any spaces or TSPSG won't build.
224
225If make step finished without errors you can generate sis installation
226file by running
227
228    make sis
229
230You'll get tspsg.sis file in the source directory. Copy it to your
231phone and run or install using Nokia PC Suite.
232
233NOTE: You need to install Qt libraries on your device before installing
234TSPSG. Usually, it should be enough to install qt_installer.sis from
235the Qt installation directory.
236
237Alternatively, if you have installed Nokia Smart Installer you can run
238
239    make installer_sis
240
241You'll get an tspsg_installer.sis that will automatically download and
242install the required Qt libraries on TSPSG installation.
243
244NOTE: Please, be aware that you have to sign the sis file to be able to
245install it on your device. You can use Open Signed Online[2] to quickly
246sign the sis file for your device. Alternatively, you can try to enable
247the installation of self-signed files in the phone settings. Please,
248reffer to your phone manual on the instructions how to do this.
249
250
2514.6. OTHER PLATFORMS, SUPPORTED BY QT
252-------------------------------------
253
254While TSPSG is oficially supported only on Linux, Windows and Windows
255Mobile it should be possible to compile it on any platform, supported
256by Qt. To do so, please, refer to the Section 4.1 for the general build
257and installation procedure.
258
259
260
2615. UNINSTALLATION
262=================
263
264Usually, it is enough to replace 'install' parameter with 'uninstall'
265in the installation command from the Section 4. Also, you can manually
266delete all installed TSPSG files and directories.
267
268
269
2706. TROUBLESHOOTING
271==================
272
2736.1. WINDRES.EXE CRASH
274----------------------
275
276When building under Windows using minGW toolchain make process may fail
277with windres.exe crash (access violation). This is a known bug in
278windres.exe regarding processing resource files with UTF-8 (cp65001)
279encoding [1]. To be able to successfully build TSPSG you will need to
280download and replace windres.exe with a fixed version. To do this:
281
282  1. Open https://sourceforge.net/projects/mingw/files/ in your
283     favourite browser.
284
285  2. Find and download the latest version of GNU Binutils. At the time
286     of writing this guide it was binutils-2.20.1-2-mingw32-bin.tar.gz.
287
288  3. Unpack the file bin\windres.exe from the downloaded archive to
289     <Your Qt installation path>\mingw\bin\ replacing the existing one.
290
291  4. Now run
292
293         mingw32-make distclean
294
295     in the TSPSG directory and repeat the installation process.
296
297
298
2997. NOTES
300========
301
302qmake doesn't always enclose installation paths in quotes. This may
303cause some files not to be installed or removed when their path
304contains spaces. In this case it is safe to delete these files and
305TSPSG installation directory manually.
306
307
308
3098. REFERNECES
310=============
311
312[1] http://sourceware.org/bugzilla/show_bug.cgi?id=10165
313[2] https://www.symbiansigned.com/app/page/public/openSignedOnline.do
314
315
316$Id: INSTALL.txt 134 2010-09-06 20:23:38Z laleppa $
317$URL: https://tspsg.svn.sourceforge.net/svnroot/tspsg/trunk/INSTALL.txt $
Note: See TracBrowser for help on using the repository browser.