diff --git a/README.md b/README.md index e844113..f827e85 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,40 @@ # GraphBuilder -Detailed information and guide will be updated approximately after 20 Jan, 2022. + +This is a project inspired by my Data Structure & Algorithm Course homework, it's used to create and visualize graphs both directed or undirected, and supports underlaying data structure of either adjacent list or multiple adjacent list + +## Functionalities + +- Create, save or read multiple layers (or might say multiple palettes) +- Draw or remove nodes and edges +- Change name, position of nodes +- Change width, direction of edges +- Animate BFS, DFS and Dijkstra's algorithm +- Change animation speed +- Change the underlaying data structure +- Change the type of graph (directed or undirected) +- Display the generated minimum spanning tree (by hiding unvisited items) +- Support algorithms on forests + +## Deploy and run + +If you want to use the packed executable, you can download it from the [release page](https://github.com/Linloir/GraphBuilder/releases) + +If you want to view the source code and run it from QT Creator, you might need: + +- QT 6.1 or above +- QT Creator installed +- QT build kit (MSVC or MinGW) installed + +Armed with the above, you can clone the repository and open the project from `GraphBuilder.pro` file in QT Creator. + +## Screenshots + +![CreatePalette](screenshots/CreatePalette.gif) + +![BFS](screenshots/BFS.gif) + +![DFS](screenshots/DFS.gif) + +![Dijkstra](screenshots/Dijkstra.gif) + +![ChangeType](screenshots/ChangeType.gif) \ No newline at end of file diff --git a/screenshots/BFS.gif b/screenshots/BFS.gif new file mode 100644 index 0000000..6518c63 Binary files /dev/null and b/screenshots/BFS.gif differ diff --git a/screenshots/ChangeType.gif b/screenshots/ChangeType.gif new file mode 100644 index 0000000..047c150 Binary files /dev/null and b/screenshots/ChangeType.gif differ diff --git a/screenshots/CreatePalette.gif b/screenshots/CreatePalette.gif new file mode 100644 index 0000000..b45dac8 Binary files /dev/null and b/screenshots/CreatePalette.gif differ diff --git a/screenshots/DFS.gif b/screenshots/DFS.gif new file mode 100644 index 0000000..9b25303 Binary files /dev/null and b/screenshots/DFS.gif differ diff --git a/screenshots/Dijkstra.gif b/screenshots/Dijkstra.gif new file mode 100644 index 0000000..75ec6e1 Binary files /dev/null and b/screenshots/Dijkstra.gif differ