Changeset 2aeaea9572 in tspsg for README.md

Timestamp:

Nov 2, 2013, 5:44:47 PM (10 years ago)

Author:

Oleksii Serdiuk

Branches:

appveyor, imgbot, master

Children:

4b975848ad

Parents:

50b202f04d

git-author:

Oleksii Serdiuk <contacts@…> (11/02/13 17:44:47)

git-committer:

Oleksii Serdiuk <contacts@…> (11/03/13 20:48:44)

Message:

Added formatting to README, INSTALL and ChangeLog? files.

File:

• README.md (modified) (2 diffs)

README.md

@@ -1 @@
-TSPSG: TSP Solver and Generator
-===============================
+TSP Solver and Generator
+========================
 
-Copyright (C) 2007-2013 Oleksii Serdiuk <contacts[at]oleksii[dot]name>
+Copyright (C) 2007-2013 [Oleksii Serdiuk](mailto:[email protected]).
 
 
-About
------
+About TSPSG
+-----------
 
-TSPSG is intended to generate and solve Travelling Salesman Problem
-(TSP) tasks. It uses Branch and Bound method for solving. Its input is
-a number of cities and a matrix of city-to-city travel costs. The
-matrix can be populated with random values in a given range (which is
-useful for generating tasks). The result is an optimal route, its
-price, step-by-step matrices of solving and a solving graph. The task
-can be saved in an internal binary format and opened later. The result
-can be printed or saved as PDF, HTML, or ODF.
+**TSP Solver and Generator** is intended to generate and solve
+**Travelling Salesman Problem** (TSP) tasks. It uses *Branch and Bound*
+method for solving. Its input is a number of cities and a matrix of
+city-to-city travel costs. The matrix can be populated with random
+values in a given range (which is useful for generating tasks). The
+result is an optimal route, its price, step-by-step matrices of solving
+and a solving graph. The task can be saved in an internal binary format
+and opened later. The result can be printed or saved as *PDF*, *HTML*,
+or *ODF*.
 
-TSPSG may be useful for teachers to generate test tasks or just for
-regular users to solve TSPs. Also, it may be used as an example of
-using Branch and Bound method to solve a particular task.
+**TSPSG** may be useful for teachers to generate test tasks or just for
+regular users to solve TSPs. Also, it may be used as an example of using
+*Branch and Bound* method to solve a particular task.
+
+You can check the [Installation Guide](INSTALL.md) or read the
+[ChangeLog](ChangeLog.md) to see what's new (updated only on releases).
 
 
@@ -43 +47 @@
 
 I'd like to give credits to the following projects which were used in
-the creation of TSP Solver and Generator:
+the creation of **TSP Solver and Generator**:
 
-  * TSPSG was created using Qt framework licensed under the terms of
-    the GNU Lesser General Public License,
-    see http://qt.nokia.com/.
+  * TSPSG was created using **Qt framework** licensed under the terms of
+    the *GNU Lesser General Public License*,
+    see <http://qt.nokia.com/>.
 
-  * Most icons used in TSPSG are part of Oxygen Icons project licensed
-    according to the GNU Lesser General Public License,
-    see http://www.oxygen-icons.org/.
+  * Most icons used in TSPSG are part of **Oxygen Icons** project
+    licensed according to the *GNU Lesser General Public License*,
+    see <http://www.oxygen-icons.org/>.
 
-  * Country flag icons used in TSPSG are part of the free Flag Icons
-    collection created by IconDrawer,
-    see http://www.icondrawer.com/.
+  * Country flag icons used in TSPSG are part of the free **Flag Icons**
+    collection created by **IconDrawer**,
+    see <http://www.icondrawer.com/>.
 
-  * TSPSG comes with the default "embedded" font DejaVu LGC Sans Mono
-    from the DejaVu fonts licensed under a Free license,
-    see http://dejavu-fonts.org/.
+  * TSPSG comes with the default "embedded" font **DejaVu LGC Sans
+    Mono** from the **DejaVu fonts** licensed under a *Free license*,
+    see <http://dejavu-fonts.org/>.
 
 
+<!--
 $Id: $Format:%h %ai %an$ $
 $URL: http://tspsg.info/ $
+-->