From c986382f1860561e61fdccb4f0394adac9f5834a Mon Sep 17 00:00:00 2001 From: iko Date: Sat, 28 Jul 2018 18:14:55 +0300 Subject: [PATCH] Create README.md --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b1828bf --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Galmin + +Galmin is a command line application for generating the full solution to the problem of the traveling salesman between six give fully connected points. + +## Input + +On launch you will be asked to enter the coordinates of six points for which the application should generate the solution. + +The weight of the edge between two given points is then calculated using the following formula: `|AB| = |Xa - Xb| + |Ya - Yb|`. + +## Output + +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. + +The `.gv` file is is a [GraphViz](http://www.graphviz.org/) file. Displays correctly only when exporting as `.svg`. + +## Support + +Swift 4. + +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).