1 | ========================== |
---|
2 | TSPSG Installation Guide |
---|
3 | ========================== |
---|
4 | |
---|
5 | Thank you for trying TSPSG. This document will guide you through the |
---|
6 | steps necessary to compile and run TSPSG. |
---|
7 | |
---|
8 | TABLE 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 | |
---|
30 | 1. REQUIREMENTS |
---|
31 | =============== |
---|
32 | |
---|
33 | To be able compile TSPSG you need to have Qt libraries. The minimum |
---|
34 | supported version of Qt is 4.5.0. The recommended version is 4.6.x |
---|
35 | or higher. |
---|
36 | |
---|
37 | NOTE: Please, note that there will be some regressions in functionality |
---|
38 | if your version of \em Qt is lower than the recommended. |
---|
39 | |
---|
40 | |
---|
41 | |
---|
42 | 2. ASSUMPTIONS |
---|
43 | ============== |
---|
44 | |
---|
45 | This guide assumes that you already have Qt libraries and all necessary |
---|
46 | prerequisites installed. |
---|
47 | |
---|
48 | Also, 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 | |
---|
63 | 3. SUPPORTED PLATFORMS |
---|
64 | ====================== |
---|
65 | |
---|
66 | TSPSG 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 | |
---|
76 | 4. BUILDING AND INSTALLATION |
---|
77 | ============================ |
---|
78 | |
---|
79 | 4.1 GENERAL PROCEDURE |
---|
80 | |
---|
81 | On 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 | |
---|
92 | NOTE: It is important to run lrelease before qmake, or qmake will not |
---|
93 | "pick up" the translations when generating installation rules. |
---|
94 | |
---|
95 | |
---|
96 | 4.2. LINUX/UNIX |
---|
97 | --------------- |
---|
98 | |
---|
99 | Open a shell, navigate to the directory where you have TSPSG source |
---|
100 | downloaded and type |
---|
101 | |
---|
102 | tar xvjf tspsg-<VERSION>-src.tar.bz2 |
---|
103 | cd tspsg-<VERSION>-src |
---|
104 | |
---|
105 | where <VERSION> is the version of TSPSG you downloaded. Now run |
---|
106 | |
---|
107 | lrelease tspsg.pro |
---|
108 | qmake tspsg.pro |
---|
109 | make |
---|
110 | |
---|
111 | In some cases you may need to type |
---|
112 | |
---|
113 | qmake tspsg.pro CONFIG+=release |
---|
114 | |
---|
115 | |
---|
116 | If make step finished without errors you can install TSPSG by running |
---|
117 | |
---|
118 | sudo make install |
---|
119 | |
---|
120 | or |
---|
121 | |
---|
122 | su |
---|
123 | make install |
---|
124 | |
---|
125 | depending on your distribution. |
---|
126 | |
---|
127 | By default, executable will go to /usr/bin, COPYING and README will go |
---|
128 | to /usr/share/TSPSG, translations will go /usr/share/TSPSG/l10n, docs |
---|
129 | will go to /usr/share/doc/TSPSG-<VERSION>. |
---|
130 | |
---|
131 | |
---|
132 | 4.3. WINDOWS |
---|
133 | ------------ |
---|
134 | |
---|
135 | NOTE: Please, read the Section 7 after reading this Section. |
---|
136 | |
---|
137 | 4.3.1. USING MINGW |
---|
138 | ~~~~~~~~~~~~~~~~~~ |
---|
139 | |
---|
140 | Unpack the downloaded source code of TSPSG with your favourite |
---|
141 | compression software. Now launch the Qt Command Prompt from the Start |
---|
142 | Menu, 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 | |
---|
148 | NOTE: Make process may fail with a crash of windres.exe. If you've run |
---|
149 | into this issue, please, read the Section 6.1. |
---|
150 | |
---|
151 | If make step finished without errors you can install TSPSG by running |
---|
152 | |
---|
153 | mingw32-make install |
---|
154 | |
---|
155 | TSPSG will be installed to %PROGRAMFILES%\TSPSG folder (usually, it is |
---|
156 | C:\Program Files\TSPSG). |
---|
157 | |
---|
158 | |
---|
159 | 4.3.2. USING VISUAL STUDIO |
---|
160 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
161 | |
---|
162 | Unpack the downloaded source code of TSPSG with your favourite |
---|
163 | compression software. Now launch the Visual Studio Command Prompt from |
---|
164 | the Start Menu, navigate to the directory where you unpacked the source |
---|
165 | and run |
---|
166 | |
---|
167 | C:\Qt\bin\lrelease tspsg.pro |
---|
168 | C:\Qt\bin\qmake tspsg.pro CONFIG+=release |
---|
169 | nmake |
---|
170 | |
---|
171 | If make step finished without errors you can install TSPSG by running |
---|
172 | |
---|
173 | nmake install |
---|
174 | |
---|
175 | TSPSG will be installed to %PROGRAMFILES%\TSPSG folder (usually, it is |
---|
176 | C:\Program Files\TSPSG). |
---|
177 | |
---|
178 | |
---|
179 | 4.4. WINDOWS CE/MOBILE |
---|
180 | ---------------------- |
---|
181 | |
---|
182 | Unpack the downloaded source code of TSPSG with your favourite |
---|
183 | compression software. Now launch the Visual Studio Command Prompt from |
---|
184 | the Start Menu and run |
---|
185 | |
---|
186 | set PATH=C:\Qt\bin;%PATH% |
---|
187 | setcepaths wincewm50pocket-msvc2008 |
---|
188 | |
---|
189 | Now 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 | |
---|
195 | There is no automated installation process for Windows Mobile build. To |
---|
196 | install TSPSG on your PDA you need to create a folder on your device |
---|
197 | and 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 | |
---|
210 | 4.5. SYMBIAN |
---|
211 | ------------ |
---|
212 | |
---|
213 | Unpack the downloaded source code of TSPSG with your favourite |
---|
214 | compression software. Now launch the Qt for Symbian Command Prompt from |
---|
215 | the Start Menu, navigate to the directory where you unpacked the source |
---|
216 | and run |
---|
217 | |
---|
218 | lrelease tspsg.pro |
---|
219 | qmake tspsg.pro CONFIG+=release |
---|
220 | make release-gcce |
---|
221 | |
---|
222 | WARNING: You need to unpack the source to the same drive as Symbian SDK |
---|
223 | and the path must not contain any spaces or TSPSG won't build. |
---|
224 | |
---|
225 | If make step finished without errors you can generate sis installation |
---|
226 | file by running |
---|
227 | |
---|
228 | make sis |
---|
229 | |
---|
230 | You'll get tspsg.sis file in the source directory. Copy it to your |
---|
231 | phone and run or install using Nokia PC Suite. |
---|
232 | |
---|
233 | NOTE: You need to install Qt libraries on your device before installing |
---|
234 | TSPSG. Usually, it should be enough to install qt_installer.sis from |
---|
235 | the Qt installation directory. |
---|
236 | |
---|
237 | Alternatively, if you have installed Nokia Smart Installer you can run |
---|
238 | |
---|
239 | make installer_sis |
---|
240 | |
---|
241 | You'll get an tspsg_installer.sis that will automatically download and |
---|
242 | install the required Qt libraries on TSPSG installation. |
---|
243 | |
---|
244 | NOTE: Please, be aware that you have to sign the sis file to be able to |
---|
245 | install it on your device. You can use Open Signed Online[2] to quickly |
---|
246 | sign the sis file for your device. Alternatively, you can try to enable |
---|
247 | the installation of self-signed files in the phone settings. Please, |
---|
248 | reffer to your phone manual on the instructions how to do this. |
---|
249 | |
---|
250 | |
---|
251 | 4.6. OTHER PLATFORMS, SUPPORTED BY QT |
---|
252 | ------------------------------------- |
---|
253 | |
---|
254 | While TSPSG is oficially supported only on Linux, Windows and Windows |
---|
255 | Mobile it should be possible to compile it on any platform, supported |
---|
256 | by Qt. To do so, please, refer to the Section 4.1 for the general build |
---|
257 | and installation procedure. |
---|
258 | |
---|
259 | |
---|
260 | |
---|
261 | 5. UNINSTALLATION |
---|
262 | ================= |
---|
263 | |
---|
264 | Usually, it is enough to replace 'install' parameter with 'uninstall' |
---|
265 | in the installation command from the Section 4. Also, you can manually |
---|
266 | delete all installed TSPSG files and directories. |
---|
267 | |
---|
268 | |
---|
269 | |
---|
270 | 6. TROUBLESHOOTING |
---|
271 | ================== |
---|
272 | |
---|
273 | 6.1. WINDRES.EXE CRASH |
---|
274 | ---------------------- |
---|
275 | |
---|
276 | When building under Windows using minGW toolchain make process may fail |
---|
277 | with windres.exe crash (access violation). This is a known bug in |
---|
278 | windres.exe regarding processing resource files with UTF-8 (cp65001) |
---|
279 | encoding [1]. To be able to successfully build TSPSG you will need to |
---|
280 | download 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 | |
---|
299 | 7. NOTES |
---|
300 | ======== |
---|
301 | |
---|
302 | qmake doesn't always enclose installation paths in quotes. This may |
---|
303 | cause some files not to be installed or removed when their path |
---|
304 | contains spaces. In this case it is safe to delete these files and |
---|
305 | TSPSG installation directory manually. |
---|
306 | |
---|
307 | |
---|
308 | |
---|
309 | 8. 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 $ |
---|