source: tspsg/INSTALL.txt @ 83e07f7194

appveyorimgbotreadme
Last change on this file since 83e07f7194 was 7ba743d983, checked in by Oleksii Serdiuk, 12 years ago

Converted svn keywords into git export-subst attribute.

However, keywords are now replaced only when you run 'git archive'.

  • Property mode set to 100644
File size: 9.9 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. COMMON INFORMATION
15     4.2. GENERAL PROCEDURE
16     4.3. LINUX/UNIX/BSD
17     4.4. WINDOWS
18          4.4.1. USING MINGW
19          4.4.2. USING VISUAL STUDIO
20     4.5. WINDOWS MOBILE
21     4.6. SYMBIAN
22     4.7. OTHER PLATFORMS, SUPPORTED BY QT
23  5. UNINSTALLATION
24  6. TROUBLESHOOTING
25     6.1. WINDRES.EXE CRASH
26  7. NOTES
27  8. REFERENCES
28
29
30
311. REQUIREMENTS
32===============
33
34To be able compile TSPSG you need to have Qt libraries. The minimum
35supported version of Qt is 4.5.0. The recommended version is 4.6.x
36or higher.
37
38NOTE: Please, note that there will be some regressions in functionality
39if your version of \em Qt is lower than the recommended.
40
41
42
432. ASSUMPTIONS
44==============
45
46This guide assumes that you already have Qt libraries and all necessary
47prerequisites installed.
48
49Also, the following assumptions are made:
50
51  - For Linux/UNIX: lrelease and qmake are avilable in $PATH.
52
53  - For Windows (minGW) and Symbian: you have installed Qt SDK or
54    prebuilt libraries and have Start Menu items for Qt tools.
55
56  - For Windows (Visual Studio) and Windows Mobile: the Qt libraries
57    reside in C:\Qt\.
58
59  - For Windows Mobile: Windows Mobile 5.0 Pocket PC SDK or later is
60    installed.
61
62
63
643. SUPPORTED PLATFORMS
65======================
66
67TSPSG is oficially supported and tested on the following platforms:
68
69  - Linux: Gentoo AMD64 and Kubuntu 9.10 64-bit AMD.
70
71  - Windows: Windows XP 32-bit and Windows 7 64-bit.
72
73  - Windows Mobile: Windows Mobile 6.5 Professional Edition.
74
75
76
774. BUILDING AND INSTALLATION
78============================
79
804.1. COMMON INFORMATION
81-----------------------
82
83To be able ot build TSPSG you need to have the following Qt modules:
84QtCore, QtGui and QtSvg. The first two are required, the last one is
85optional. To get support for additional image formats (i.e., JPEG and
86TIFF) you'll additionally need corresponding Qt imageformats plugins.
87
88If you want to build TSPSG without SVG support add nosvg to qmake
89CONFIG parameter, so that qmake command will typically be:
90
91    qmake CONFIG+=release CONFIG+=nosvg
92
93This way you will not depend on QtSvg module but will not be able to
94export solution graph in SVG format.
95
96
97TSPSG uses qmake PREFIX parameter to determine installation path for
98make install command. If you don't specify it when running qmake, it
99will be assigned the default value depending on the platform:
100
101 Platform          | Default PREFIX value
102-------------------|-------------------------------------
103 Linux/UNIX/BSD    | /usr
104-------------------|-------------------------------------
105 Windows           | %PROGRAMFILES% environment variable
106                   | (usually, it is "C:\Program Files")
107-------------------|-------------------------------------
108 Windows CE/Mobile | "\Program Files"
109-------------------|-------------------------------------
110 Symbian           | <ignored>
111-------------------|-------------------------------------
112
113NOTE: Please, note that there are no installation and/or packaging
114rules for MacOS and other platforms not mentioned in this table.
115
116
117By default, TSPSG uses precompiled header when being built. If you
118experience problems with it you may add CONFIG+=nopch parameter to
119qmake to disable the generation and use of the precompiled header.
120
121
1224.2. GENERAL PROCEDURE
123----------------------
124
125On most platforms the general building and installation procedure is:
126
127  1. Run lrelease to generate binary translation files (.qm) from the
128     source (.ts).
129
130  2. Run qmake with CONFIG+=release parameter to generate makefiles.
131
132  3. Run make utility (e.g., make, nmake, mingw32-make) to build TSPSG.
133
134  4. Run make utility with 'install' parameter (without quotes).
135
136NOTE: It is important to run lrelease before qmake, or qmake will not
137"pick up" the translations when generating installation rules.
138
139
1404.3. LINUX/UNIX/BSD
141-------------------
142
143Open a shell, navigate to the directory where you have TSPSG source
144downloaded and type
145
146    tar xvjf tspsg-<VERSION>-src.tar.bz2
147    cd tspsg-<VERSION>-src
148
149where <VERSION> is the version of TSPSG you downloaded. Now run
150
151    lrelease tspsg.pro
152    qmake tspsg.pro
153    make
154
155In some cases you may need to type
156
157    qmake tspsg.pro CONFIG+=release
158
159
160If make step finished without errors you can install TSPSG by running
161
162    sudo make install
163
164or
165
166    su
167    make install
168
169depending on your distribution.
170
171The executable goes to <PREFIX>/bin; COPYING, ChangeLog.txt, README.txt
172and INSTALL.txt go to <PREFIX>/share/doc/TSPSG-<VERSION>.
173
174
1754.4. WINDOWS
176------------
177
178TSPSG will be installed to <PREFIX>\TSPSG folder.
179
180NOTE: Please, read the Section 7 after reading this Section.
181
1824.4.1. USING MINGW
183~~~~~~~~~~~~~~~~~~
184
185Unpack the downloaded source code of TSPSG with your favourite
186compression software. Now launch the Qt Command Prompt from the Start
187Menu, navigate to the directory where you unpacked the source and run
188
189    lrelease tspsg.pro
190    qmake tspsg.pro CONFIG+=release
191    mingw32-make
192
193NOTE: Make process may fail with a crash of windres.exe. If you've run
194into this issue, please, read the Section 6.1.
195
196If make step finished without errors you can install TSPSG by running
197
198    mingw32-make install
199
200
2014.4.2. USING VISUAL STUDIO
202~~~~~~~~~~~~~~~~~~~~~~~~~~
203
204Unpack the downloaded source code of TSPSG with your favourite
205compression software. Now launch the Visual Studio Command Prompt from
206the Start Menu, navigate to the directory where you unpacked the source
207and run
208
209    C:\Qt\bin\lrelease tspsg.pro
210    C:\Qt\bin\qmake tspsg.pro CONFIG+=release
211    nmake
212
213If make step finished without errors you can install TSPSG by running
214
215    nmake install
216
217
2184.5. WINDOWS CE/MOBILE
219----------------------
220
221Unpack the downloaded source code of TSPSG with your favourite
222compression software. Now launch the Visual Studio Command Prompt from
223the Start Menu and run
224
225    set PATH=C:\Qt\bin;%PATH%
226    setcepaths wincewm50pocket-msvc2008
227
228Now navigate to the directory where you unpacked the source and run
229
230    lrelease tspsg.pro
231    qmake tspsg.pro CONFIG+=release
232    nmake
233
234There is no automated installation process for Windows Mobile build. To
235install TSPSG on your PDA you need to create a folder on your device
236and copy the following files to it:
237
238  - tspsg.exe from release folder in the source directory.
239
240  - QtCore4.dll and QtGui4.dll from C:\Qt\bin folder.
241
242  - msvcr90.dll from
243    C:\Program Files\Microsoft Visual Studio 9.0\VC\ce\dll\armv4i folder.
244
245  - all *.qm files from l10n folder in the source directory to l10n
246    subfolder.
247
248
2494.6. SYMBIAN
250------------
251
252Unpack the downloaded source code of TSPSG with your favourite
253compression software. Now launch the Qt for Symbian Command Prompt from
254the Start Menu, navigate to the directory where you unpacked the source
255and run
256
257    lrelease tspsg.pro
258    qmake tspsg.pro CONFIG+=release
259    make release-gcce
260
261WARNING: You need to unpack the source to the same drive as Symbian SDK
262and the path must not contain any spaces or TSPSG won't build.
263
264If make step finished without errors you can generate sis installation
265file by running
266
267    make sis
268
269You'll get tspsg.sis file in the source directory. Copy it to your
270phone and run or install using Nokia PC Suite.
271
272NOTE: You need to install Qt libraries on your device before installing
273TSPSG. Usually, it should be enough to install qt_installer.sis from
274the Qt installation directory.
275
276Alternatively, if you have installed Nokia Smart Installer you can run
277
278    make installer_sis
279
280You'll get an tspsg_installer.sis that will automatically download and
281install the required Qt libraries on TSPSG installation.
282
283NOTE: Please, be aware that you have to sign the sis file to be able to
284install it on your device. You can use Open Signed Online[2] to quickly
285sign the sis file for your device. Alternatively, you can try to enable
286the installation of self-signed files in the phone settings. Please,
287reffer to your phone manual on the instructions how to do this.
288
289
2904.7. OTHER PLATFORMS, SUPPORTED BY QT
291-------------------------------------
292
293While TSPSG is oficially supported only on Linux, Windows and Windows
294Mobile it should be possible to compile it on any platform, supported
295by Qt. To do so, please, refer to the Section 4.1 for the general build
296and installation procedure.
297
298
299
3005. UNINSTALLATION
301=================
302
303Usually, it is enough to replace 'install' parameter with 'uninstall'
304in the installation command from the Section 4. Also, you can manually
305delete all installed TSPSG files and directories.
306
307
308
3096. TROUBLESHOOTING
310==================
311
3126.1. WINDRES.EXE CRASH
313----------------------
314
315When building under Windows using minGW toolchain make process may fail
316with windres.exe crash (access violation). This is a known bug in
317windres.exe regarding processing resource files with UTF-8 (cp65001)
318encoding [1]. To be able to successfully build TSPSG you will need to
319download and replace windres.exe with a fixed version. To do this:
320
321  1. Open https://sourceforge.net/projects/mingw/files/ in your
322     favourite browser.
323
324  2. Find and download the latest version of GNU Binutils. At the time
325     of writing this guide it was binutils-2.20.1-2-mingw32-bin.tar.gz.
326
327  3. Unpack the file bin\windres.exe from the downloaded archive to
328     <Your Qt installation path>\mingw\bin\ replacing the existing one.
329
330  4. Now run
331
332         mingw32-make distclean
333
334     in the TSPSG directory and repeat the installation process.
335
336
337
3387. NOTES
339========
340
341qmake doesn't always enclose installation paths in quotes. This may
342cause some files not to be installed or removed when their path
343contains spaces. In this case it is safe to delete these files and
344TSPSG installation directory manually.
345
346
347
3488. REFERNECES
349=============
350
351[1] http://sourceware.org/bugzilla/show_bug.cgi?id=10165
352[2] https://www.symbiansigned.com/app/page/public/openSignedOnline.do
353
354
355$Id: $Format:%h %ai %an$ $
356$URL: http://tspsg.info/ $
Note: See TracBrowser for help on using the repository browser.