Changeset 6221a58c7c in tspsg for INSTALL.md


Ignore:
Timestamp:
Nov 2, 2013, 5:44:47 PM (10 years ago)
Author:
Oleksii Serdiuk
Branches:
readme
Parents:
50b202f04d
git-author:
Oleksii Serdiuk <contacts@…> (11/02/13 17:44:47)
git-committer:
Oleksii Serdiuk <contacts@…> (11/02/13 21:31:48)
Message:

Some formatting changes to README, INSTALL and ChangeLog? files.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • INSTALL.md

    r50b202f04d r6221a58c7c  
    22========================
    33
    4 Thank you for trying TSPSG. This document will guide you through the
    5 steps necessary to compile and run TSPSG.
    6 
    7 TABLE 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 
    30 1. REQUIREMENTS
     4Thank you for trying **TSPSG**. This document will guide you through the
     5steps necessary to compile and run **TSPSG**.
     6
     7
     81. Requirements
    319---------------
    3210
    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
     11To be able compile **TSPSG** you need to have
     12*[Qt libraries](http://qt-project.org/)*. The minimum supported version
     13of *Qt* is **4.5.0**. The recommended version is **4.6.x** or higher.
     14
     15**NOTE**: Please, note that there will be some regressions in
     16functionality if your version of *Qt* is lower than the recommended.
     17
     18
     192. Assumptions
    4320--------------
    4421
    45 This guide assumes that you already have Qt libraries and all necessary
    46 prerequisites installed.
     22This guide assumes that you already have *Qt* libraries and all
     23necessary prerequisites installed.
    4724
    4825Also, the following assumptions are made:
    4926
    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
     27  - For **Linux/UNIX/BSD**: `lrelease` and `qmake` are avilable in
     28    `$PATH`.
     29  - For **Windows** (*MinGW*) and **Symbian**: you have installed *Qt
     30    SDK* or prebuilt libraries and have Start Menu items for Qt tools.
     31  - For **Windows** (*Visual Studio*) and **Windows Mobile**: the *Qt*
     32    libraries reside in `C:\Qt\`.
     33  - For **Windows Mobile**: *Windows Mobile 5.0 Pocket PC SDK* or later
     34    is installed.
     35
     36
     373. Supported Platforms
    6438----------------------
    6539
    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
     40**TSPSG** is oficially supported and tested on the following platforms:
     41
     42  - **Linux**: *Gentoo AMD64* and *Kubuntu 9.10 64-bit AMD*.
     43  - **Windows**: *Windows XP 32-bit* and *Windows 7 64-bit*.
     44  - **Windows Mobile**: *Windows Mobile 6.5 Professional Edition*.
     45
     46
     474. Building and Installation
    7748----------------------------
    7849
    79 ### 4.1. COMMON INFORMATION ###
    80 
    81 To be able ot build TSPSG you need to have the following Qt modules:
    82 QtCore, QtGui and QtSvg. The first two are required, the last one is
    83 optional. To get support for additional image formats (i.e., JPEG and
    84 TIFF) you'll additionally need corresponding Qt imageformats plugins.
    85 
    86 If you want to build TSPSG without SVG support add nosvg to qmake
    87 CONFIG parameter, so that qmake command will typically be:
     50### 4.1. Common Information ###
     51
     52To be able ot build **TSPSG** you need to have the following *Qt*
     53modules: *QtCore*, *QtGui* and *QtSvg*. The first two are required, the
     54last one is optional. To get support for additional image formats (i.e.,
     55**JPEG** and **TIFF**) you'll additionally need corresponding *Qt
     56imageformats* plugins.
     57
     58If you want to build **TSPSG** without **SVG** support add `nosvg` to
     59*qmake* `CONFIG` parameter, so that *qmake* command will typically be:
    8860
    8961    qmake CONFIG+=release CONFIG+=nosvg
    9062
    91 This way you will not depend on QtSvg module but will not be able to
    92 export solution graph in SVG format.
    93 
    94 
    95 TSPSG uses qmake PREFIX parameter to determine installation path for
    96 make install command. If you don't specify it when running qmake, it
     63This way you will not depend on *QtSvg* module but will not be able to
     64export solution graph in **SVG** format.
     65
     66
     67**TSPSG** uses *qmake* `PREFIX` parameter to determine installation path
     68for make install command. If you don't specify it when running qmake, it
    9769will be assigned the default value depending on the platform:
    9870
    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 
    111 NOTE: Please, note that there are no installation and/or packaging
    112 rules for MacOS and other platforms not mentioned in this table.
    113 
    114 
    115 By default, TSPSG uses precompiled header when being built. If you
    116 experience problems with it you may add CONFIG+=nopch parameter to
    117 qmake to disable the generation and use of the precompiled header.
    118 
    119 
    120 ### 4.2. GENERAL PROCEDURE ###
     71| Platform              | Default `PREFIX` value                  |
     72|-----------------------|-----------------------------------------|
     73| **Linux/UNIX/BSD**    | `/usr`                                  |
     74| **Windows**           | `%PROGRAMFILES%` environment variable\* |
     75| **Windows CE/Mobile** | `\Program Files`                        |
     76| **Symbian**           | *\<ignored\>*                           |
     77
     78\* - usually, it is `C:\Program Files`.
     79
     80**NOTE**: Please, note that there are no installation and/or packaging
     81rules for **MacOS** and other platforms not mentioned in this table.
     82
     83
     84By default, **TSPSG** uses precompiled header when being built. If you
     85experience problems with it you may add `CONFIG+=nopch` parameter to
     86*qmake* to disable the generation and use of the precompiled header.
     87
     88
     89### 4.2. General Procedure ###
    12190
    12291On most platforms the general building and installation procedure is:
    12392
    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 
    133 NOTE: 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 
    139 Open a shell, navigate to the directory where you have TSPSG source
     93  1. Run `lrelease` to generate binary translation files (*.qm*) from
     94     the source (*.ts*).
     95  2. Run `qmake` with `CONFIG+=release` parameter to generate makefiles.
     96  3. Run `make` utility (e.g., *make*, *nmake*, *mingw32-make*) to build
     97     **TSPSG**.
     98  4. Run `make` utility with `install` parameter.
     99
     100NOTE: It is important to run `lrelease` before `qmake`, or `qmake` will
     101not "pick up" the translations when generating installation rules.
     102
     103
     104### 4.3. Linux/UNIX/BSD ###
     105
     106Open a shell, navigate to the directory where you have **TSPSG** source
    140107downloaded and type
    141108
    … …  
    143110    cd tspsg-<VERSION>-src
    144111
    145 where <VERSION> is the version of TSPSG you downloaded. Now run
     112where *\<VERSION\>* is the version of **TSPSG** you downloaded. Now run
    146113
    147114    lrelease tspsg.pro
    … …  
    165132depending on your distribution.
    166133
    167 The executable goes to <PREFIX>/bin; COPYING, ChangeLog.txt, README.txt
    168 and INSTALL.txt go to <PREFIX>/share/doc/TSPSG-<VERSION>.
    169 
    170 
    171 ### 4.4. WINDOWS ###
     134The executable goes to `<PREFIX>/bin`; *COPYING*, *ChangeLog.md*,
     135*README.md* and *INSTALL.md* go to `<PREFIX>/share/doc/TSPSG-<VERSION>`.
     136
     137
     138### 4.4. Windows ###
    172139
    173140TSPSG will be installed to <PREFIX>\TSPSG folder.
    … …  
    176143
    177144
    178 #### 4.4.1. USING MINGW ####
     145#### 4.4.1. Using MinGW ####
    179146
    180147Unpack the downloaded source code of TSPSG with your favourite
    … …  
    194161
    195162
    196 #### 4.4.2. USING VISUAL STUDIO ####
     163#### 4.4.2. Using Visual Studio ####
    197164
    198165Unpack the downloaded source code of TSPSG with your favourite
    … …  
    210177
    211178
    212 ### 4.5. WINDOWS CE/MOBILE ###
     179### 4.5. Windows CE/Mobile ###
    213180
    214181Unpack the downloaded source code of TSPSG with your favourite
    … …  
    240207
    241208
    242 ### 4.6. SYMBIAN ###
     209### 4.6. Symbian ###
    243210
    244211Unpack the downloaded source code of TSPSG with your favourite
    … …  
    280247
    281248
    282 ### 4.7. OTHER PLATFORMS, SUPPORTED BY QT ###
     249### 4.7. Other Platforms, Supported by Qt ###
    283250
    284251While TSPSG is oficially supported only on Linux, Windows and Windows
    … …  
    289256
    290257
    291 5. UNINSTALLATION
     2585. Uninstallation
    292259-----------------
    293260
    … …  
    298265
    299266
    300 6. TROUBLESHOOTING
     2676. Troubleshooting
    301268------------------
    302269
    303270
    304 ### 6.1. WINDRES.EXE CRASH ###
     271### 6.1. WINDRES.EXE Crash ###
    305272
    306273When building under Windows using minGW toolchain make process may fail
    … …  
    327294
    328295
    329 7. NOTES
     2967. Notes
    330297--------
    331298
    … …  
    337304
    338305
    339 8. REFERNECES
     3068. References
    340307-------------
    341308
    … …  
    344311
    345312
     313<!--
    346314$Id: $Format:%h %ai %an$ $
    347315$URL: http://tspsg.info/ $
     316-->
Note: See TracChangeset for help on using the changeset viewer.