Skip to content

Commit af1c26f

Browse files
committed
2.0.0 release 🥳
1 parent 408968d commit af1c26f

File tree

7 files changed

+64
-3
lines changed

7 files changed

+64
-3
lines changed

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "rust_graph_visualiser"
3-
version = "1.9.5"
3+
version = "2.0.0"
44
edition = "2021"
55
authors = ["Sandra"]
66
repository = "https://github.com/an-Iceberg/rust_graph_visualiser"

README.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
<h1 align="center">
2+
<img width="200" alt="Rust Graph Visualiser Logo" src="./rust_graph_vis_logo.png">
3+
<br>
4+
Rust Graph Visualiser
5+
</h1>
6+
7+
## Contents
8+
- [Description](#description)
9+
- [Screenshots](#screenshots)
10+
- [Installation](#installation)
11+
- [Precompiled binaries](#precompiled-binaries)
12+
- [Compile from source](#compile-from-source)
13+
- [Possible future additions (no guarantee)](#possible-future-additions-no-guarantee)
14+
- [Acknowledgements](#acknowledgements)
15+
16+
![](rainbow_bar.png)
17+
18+
## Description
19+
A visualisation program that showcases what a graph is (in the context of <abbr title="computer science">CS</abbr>).
20+
It allows the user to create a graph that has at most 100 nodes and to connect those nodes freely with
21+
weighted edges. Bidirectional edges are also supported. One can also specify a start and end node and
22+
if possible the program tires to find the shortest path between the two.
23+
24+
All the instructions and configurations can be done inside the program, although the configuration isn't
25+
persistent.
26+
27+
This program is also available as a [web app](https://an-iceberg.github.io/rust_graph_visualiser).
28+
29+
![](rainbow_bar.png)
30+
31+
## Screenshots
32+
33+
![](Screenshot%202023-12-16%20185315.png)
34+
35+
![](rainbow_bar.png)
36+
37+
## Installation
38+
39+
### Precompiled binaries
40+
41+
Precompiled binaries are available for Linux and Windows. Download the
42+
[latest version](https://github.com/an-Iceberg/rust_graph_visualiser/releases/latest)
43+
from the [releases page](https://github.com/an-Iceberg/rust_graph_visualiser/releases).
44+
45+
### Compile from source
46+
47+
1. Make sure the latest version of [Rust](https://www.rust-lang.org/) is installed on your system.
48+
2. Clone this repository onto your machine: `git clone https://github.com/an-Iceberg/rust_graph_visualiser && cd ./rust_graph_visualiser`
49+
3. Compile the program with: `cargo build --release`
50+
4. After it is done compiling the binary can be found at `rust_graph_visualiser/target/release/`.
51+
52+
![](rainbow_bar.png)
53+
54+
## Possible future additions (no guarantee)
55+
- Minimum spanning tree
56+
57+
![](rainbow_bar.png)
58+
59+
## Acknowledgements
60+
- Creator of the cmatrix `README` for the awesome idea of the rainbow bar.
61+
- [Javidx9](https://github.com/OneLoneCoder) (aka. OneLoneCoder) for being an awesome teacher

Screenshot 2023-12-16 185315.png

98.4 KB
Loading

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@
121121
event.preventDefault()
122122
}, false);
123123
</script>
124-
<script>load("rust_graph_visualiser@v1.9.5.wasm");</script>
124+
<script>load("rust_graph_visualiser@v2.0.0.wasm");</script>
125125
</body>
126126

127127
</html>
Binary file not shown.

rainbow_bar.png

2.86 KB
Loading

0 commit comments

Comments
 (0)