@@ -0,0 +1,21 @@
1+# Galmin
2+
3+Galmin is a command line application for generating the full solution to the problem of the traveling salesman between six give fully connected points.
4+
5+## Input
6+
7+On launch you will be asked to enter the coordinates of six points for which the application should generate the solution.
8+
9+The weight of the edge between two given points is then calculated using the following formula: `|AB| = |Xa - Xb| + |Ya - Yb|`.
10+
11+## Output
12+
13+Out files are created in the directory `diskraDz3`. Output consists of six `.csv` files and one `.gv` file for every step of the solution and one `solution.txt` containing the actual solution to the problem.
14+
15+The `.gv` file is is a [GraphViz](http://www.graphviz.org/) file. Displays correctly only when exporting as `.svg`.
16+
17+## Support
18+
19+Swift 4.
20+
21+Is intended to work as a mac command line application. Linux support is rudimentary. Doesn't work with embedded standard library (requires Swift standard library to be installed).