feat: DOCS.md addition

Signed-off-by: Vyacheslav Kochergin <[email protected]>
spbu-coding-2023 · May 29, 2024 · c400a2d · c400a2d
1 parent adf1612
commit c400a2d
Show file tree

Hide file tree

Showing 13 changed files with 82 additions and 0 deletions.
diff --git a/DOCS.md b/DOCS.md
@@ -0,0 +1,82 @@
+# Documentation
+
+You need to clone our repository and run the app using
+
+```
+./gradlew run
+```
+
+## How to use
+
+Firstly, you need to choose a graph
+
+![graph-choose](src/main/resources/graph-choose.png)
+
+## Undirected unweighted graph
+
+Here is the example of our graph window
+
+![graph](src/main/resources/graph.png)
+
+If you click "Reset", graph will become as it was before you started manipulating it.
+
+If you click "Algorithms", you will be suggested to use algorithms of this graph
+
+![graph-algos](src/main/resources/graph-algos.png)
+
+### Bridges
+
+Bridge edges are highlighted with red color.
+
+![bridge](src/main/resources/bridge.png)
+
+### Cycles search for given vertex
+
+You are suggested to put in a number of chosen vertex
+
+![cycles-vertex-choose.png](src/main/resources/cycle-vertex-choose.png)
+
+Then you receive highlighted cycle of this vertex, or vertex becomes highlighted with blue color if it doesn't belong to any cycle
+
+![cycle](src/main/resources/cycle.png)
+
+### Key vertices selection
+
+You receive highlighted key vertices of this graph
+
+![key-vertices](src/main/resources/key-vertices.png)
+
+## Directed unweighted graph
+
+Directed graph has some undirected graph algorithms, but also there is selection of strongly connected components.
+
+### Strongly connected components selection
+
+Each component is highlighted with its unique color.
+
+![scc](src/main/resources/scc.png)
+
+## Undirected weighted graph
+
+In weighted graph, you can see weights of edges
+
+![edges-weights](src/main/resources/edges-weights.png)
+
+### Minimal spanning tree construction
+
+Included edges are highlighted with red
+
+![mst](src/main/resources/mst.png)
+
+### Path finding
+
+To find a path, you need to pick source and destination vertices
+
+![path-vertices](src/main/resources/path-vertices.png)
+
+Path is highlighted. Notice that we don't support negative weights for path finding in undirected graph.
+
+![path](src/main/resources/path.png)
+
+## Weighted directed graph
+All its algorithms are already explained above
diff --git a/src/main/resources/bridge.png b/src/main/resources/bridge.png
diff --git a/src/main/resources/cycle-vertex-choose.png b/src/main/resources/cycle-vertex-choose.png
diff --git a/src/main/resources/cycle.png b/src/main/resources/cycle.png
diff --git a/src/main/resources/edges-weights.png b/src/main/resources/edges-weights.png
diff --git a/src/main/resources/graph-algos.png b/src/main/resources/graph-algos.png
diff --git a/src/main/resources/graph-choose.png b/src/main/resources/graph-choose.png
diff --git a/src/main/resources/graph.png b/src/main/resources/graph.png
diff --git a/src/main/resources/key-vertices.png b/src/main/resources/key-vertices.png
diff --git a/src/main/resources/mst.png b/src/main/resources/mst.png
diff --git a/src/main/resources/path-vertices.png b/src/main/resources/path-vertices.png
diff --git a/src/main/resources/path.png b/src/main/resources/path.png
diff --git a/src/main/resources/scc.png b/src/main/resources/scc.png