Skip to content

Commit

Permalink
Merge pull request #1 from PjrCodes/main
Browse files Browse the repository at this point in the history
add readme for you :)
  • Loading branch information
nikhilhenry authored Nov 14, 2023
2 parents bc942b1 + 3ff526b commit 3aead7f
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# astar.rs

A blazingly-fast [A-Star](https://en.wikipedia.org/wiki/A*_search_algorithm) search algorithm and visualisation written in Rust. GUI powered by [egui](https://www.egui.rs/).

Allows for dynamic grid sizes and user-chosen heuristics. Runs natively on MacOS, Linux and the web using WASM!

## Demo
The WASM-based demo of the app is hosted [here](https:/nikhilhenry.github.io/astar.rs).

## Installation

Prebuilt binaries for MacOS can be found on the releases page.

For other platforms, clone the repo and run:

```bash
cargo run --release
```
...with Rust installed ofc ;)

## Changelog

### Version v0.0.1 [14-11-2023]
- Initial release
- Support for up to 50x50 grids
- Supports up to 3 heuristics
- Builds for both WASM and x86_64

Icon credits - [Václav Vančura](https://www.figma.com/community/file/857303226040719059)

0 comments on commit 3aead7f

Please sign in to comment.