source: tspsg/INSTALL.md @ 50b202f04d

appveyorimgbotreadme
Last change on this file since 50b202f04d was 50b202f04d, checked in by Oleksii Serdiuk, 11 years ago

Converted README, INSTALL and ChangeLog? files into Markdown format.

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