-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from PjrCodes/main
add readme for you :)
- Loading branch information
Showing
1 changed file
with
29 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |