userguide refactor

README.md

@@ -9,4 +9,7 @@
 [Reports](https://github.com/NuiS4ncE/PathfindingLab/tree/master/documentation/reports)
 </br>
 [Test documentation](https://github.com/NuiS4ncE/PathfindingLab/blob/master/documentation/testdocumentation.md)
-
+</br>
+[User guide]()
+</br>
+[Release]()

build.gradle

@@ -31,6 +31,10 @@ jar {
     manifest {
         attributes 'Main-Class': 'PathfindingLab.Main'
     }
+    from {
+        configurations.runtimeClasspath.collect { it.isDirectory()? it : zipTree(it) }
+    }
+
 }
 
 

documentation/userguide.md

@@ -0,0 +1,41 @@
+# User guide
+
+Download the zip file, unzip the files and run the command from terminal in PathfindingLab directory:
+
+`./gradlew jar`
+
+Go to the directory where the jar file is located by writing:
+
+`cd build/libs`
+
+
+and write the command: 
+
+`java -jar PathfindingLab.jar`
+
+## Opening a map
+
+Maps are included with the files and can be located by pressing the button
+__Open__ and finding a map from the directory. 
+
+## Choosing the algorithm
+
+The algorithm is chosen by using the drop-down list under the __Open__ button.  
+
+## Setting start and end points 
+
+You can set the start point for the path by toggling the __Start__ button 
+and clicking on a spot on the map. End point can be set the same way by toggling the __End__ button. 
+
+## Running the algorithm
+
+The algorithm is run by pressing the __Run__ button.
+
+## Clearing the map
+
+The map can be cleared by pressing the __Clear__ button. 
+
+## Closing the application 
+
+The application can be closed by pressing the __X__ in the top-right corner 
+or pressing the __Exit__ button. 

src/main/java/PathfindingLab/algorithms/IDAStar.java

@@ -11,6 +11,7 @@
 import static java.lang.Math.abs;
 import static java.lang.Math.sqrt;
 
+//This algorithm doesn't work therefore the class doesn't work either.
 public class IDAStar {
 
     Node startNode, routeFinal, visitedNode;

src/main/java/PathfindingLab/ui/GUI.java

@@ -204,7 +204,7 @@ public ComboBox<String> comboBoxFilter() {
         ComboBox<String> comboBox = new ComboBox<>();
         comboBox.getItems().add("Dijkstra");
         comboBox.getItems().add("AStar");
-        comboBox.getItems().add("IDAStar");
+        //comboBox.getItems().add("IDAStar");
         comboBox.setEditable(false);
         comboBox.setValue("");
 
@@ -305,8 +305,6 @@ public MyList<Node> printRoute(DijkstraPath dijkstraPath, AStar aStar, IDAStar i
         } else {
             System.out.println("Route not found! " + routeNodes.toString());
         }
-        System.out.println(routeNodes.toString());
-        System.out.println("WHAT");
         return routeNodes;
     }