Update Readme

This commit is contained in:
Linloir 2022-11-02 17:06:37 +08:00
parent 629698c05c
commit e965427be4
No known key found for this signature in database
GPG Key ID: 58EEB209A0F2C366
6 changed files with 39 additions and 1 deletions

View File

@ -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)

BIN
screenshots/BFS.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.4 MiB

BIN
screenshots/ChangeType.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.8 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.0 MiB

BIN
screenshots/DFS.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.4 MiB

BIN
screenshots/Dijkstra.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.6 MiB