paoda
/
mandelbrot
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

chore: update README

This commit is contained in:
Rekai Musuka 2020-11-26 15:40:13 -06:00
parent 99b4104261
commit 3de871a6f7
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -15,11 +15,17 @@ An interactive interface where you can navigate the Mandelbrot Set.
<kbd>E</kbd> Zoom In
### How to Use
Due to Bevy, this program depends on `lldb`, `llvm` and Rust Nightly (as of 2020-11-26)
### Build Instructions
Due to my current configuration (which is one that prioritizes quick development), Bevy requires
some dependencies in order to build this project. These dependencies are `clang`, `lldb`, and `llvm`.
Also, this program requires Rust Nightly (as of 2020-11-26)
Once done, you can build the program with `cargo build`, or `cargo build --release`
### Run Instructions
You can either execut the compiled binary, or use cargo and run `cargo run --release`
Once all these prerequisites have been satisfied, you can run `cargo run --release` in the
project root directory.
### TODO
* Make Zooming feel more natural (where you zoom to is fixed, and not centered)