From 3de871a6f7378130276447308d491b9df76df26b Mon Sep 17 00:00:00 2001 From: Rekai Musuka <--show> Date: Thu, 26 Nov 2020 15:40:13 -0600 Subject: [PATCH] chore: update README --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e0a763a..f276502 100644 --- a/README.md +++ b/README.md @@ -15,11 +15,17 @@ An interactive interface where you can navigate the Mandelbrot Set. E 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)