source: tspsg/doc/dox/mainpage.dox @ 2d4659ddfe

appveyorimgbotreadme
Last change on this file since 2d4659ddfe was 4a5e9a66d4, checked in by Oleksii Serdiuk, 12 years ago

Renamed docs folder to doc to follow Qt naming convention.

Also created doc target for make so that documentation can now be
generated by running 'make doc'.

  • Property mode set to 100644
File size: 2.0 KB
Line 
1/*! \mainpage
2<!--
3$Id: $Format:%h %ai %an$ $
4$URL: http://tspsg.info/ $
5-->
6
7\image html tspsg.png
8<b>TSPSG: TSP Solver and Generator</b>
9\author Copyright &copy; 2007-2012 Oleksii Serdiuk <contacts[at]oleksii[dot]name>
10
11\b Homepage: <a href="http://tspsg.info/">tspsg.info</a>
12
13\section m_s1 ABOUT TSPSG
14
15\b TSPSG is intended to generate and solve <b>Travelling Salesman Problem</b>
16(TSP) tasks. It uses <em>Branch and Bound method</em> for solving. Its input is
17a number of cities and a matrix of city-to-city travel costs. The
18matrix can be populated with random values in a given range (which is
19useful for generating tasks). The result is an optimal route, its
20price, step-by-step matrices of solving and a solving graph. The task
21can be saved in an internal binary format and opened later. The result
22can be printed or saved as \b PDF, \b HTML, or \b ODF.
23
24\b TSPSG may be useful for teachers to generate test tasks or just for
25regular users to solve TSPs. Also, it may be used as an example of
26using <em>Branch and Bound method</em> to solve a particular task.
27
28
29\section m_s2 DOCUMENTATION PAGES
30
31\ref changelog
32
33  -# \ref cl_b170
34  -# \ref cl_b145
35  -# \ref cl_b100
36  -# \ref cl_b42
37
38
39\ref install
40
41  -# \ref i_s1
42  -# \ref i_s2
43  -# \ref i_s3
44  -# \ref i_s4
45  -# \ref i_s5
46  -# \ref i_s6
47  -# \ref i_s7
48  -# \ref i_s8
49
50
51\section m_s3 LICENSE
52
53This program is free software: you can redistribute it and/or modify\n
54it under the terms of the GNU General Public License as published by\n
55the Free Software Foundation, either version 3 of the License, or\n
56(at your option) any later version.\n
57
58This program is distributed in the hope that it will be useful,\n
59but WITHOUT ANY WARRANTY; without even the implied warranty of\n
60MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n
61\ref license "GNU General Public License" for more details.\n
62
63You should have received a copy of the \ref license "GNU General Public License"\n
64along with this program.  If not, see <http://www.gnu.org/licenses/>.
65*/
Note: See TracBrowser for help on using the repository browser.