chore: Update README.md
This commit is contained in:
parent
9222835f5d
commit
70def0657d
56
README.md
56
README.md
|
@ -3,34 +3,46 @@
|
|||
An interactive interface where you can navigate the Mandelbrot Set.
|
||||
|
||||
### Controls
|
||||
<kbd>W</kbd> - Up
|
||||
<br />
|
||||
<kbd>A</kbd> - Left
|
||||
<br />
|
||||
<kbd>S</kbd> - Down
|
||||
<br />
|
||||
<kbd>D</kbd> - Right
|
||||
|
||||
<kbd>Q</kbd> Zoom Out
|
||||
<br />
|
||||
<kbd>E</kbd> Zoom In
|
||||
#### 2D Movement
|
||||
Key | Action
|
||||
--- | ---
|
||||
<kbd>W</kbd> | Up
|
||||
<kbd>A</kbd> | Left
|
||||
<kbd>S</kbd> | Down
|
||||
<kbd>D</kbd> | Right
|
||||
|
||||
#### Zoom
|
||||
Key | Action
|
||||
--- | ---
|
||||
<kbd>Q</kbd> | Zoom Out
|
||||
<kbd>E</kbd> | Zoom In
|
||||
|
||||
#### 2D and Zoom Scale
|
||||
Key | Action
|
||||
--- | ---
|
||||
<kbd>R</kbd> | Increase Scale
|
||||
<kbd>F</kbd> | Decrease Scale
|
||||
|
||||
#### Mandelbrot Iteration Limit (Max 512 by default)
|
||||
Key | Action
|
||||
--- | ---
|
||||
<kbd>T</kbd> | Increment by a factor of 2
|
||||
<kbd>G</kbd> | Decrement by a factor of 2
|
||||
|
||||
|
||||
|
||||
### 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`, `lld`, 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`
|
||||
You can build the program with `cargo build`, or `cargo build --release` on stable.
|
||||
|
||||
### Run Instructions
|
||||
You can either execut the compiled binary, or use cargo and run `cargo run --release`
|
||||
You can either execute the compiled binary, or use `cargo run --release`
|
||||
|
||||
|
||||
### TODO
|
||||
* Make Zooming feel more natural (where you zoom to is fixed, and not centered)
|
||||
* Make the amount of iterations done when calculating the Mandelbrot set configurable
|
||||
* preferrably with a keybind
|
||||
* Add smooth colouring
|
||||
* Maybe look into histograms?
|
||||
- [x] Make Zooming feel more natural (where you zoom to is fixed, and not centred)
|
||||
- [x] Make the amount of iterations done when calculating the Mandelbrot set configurable
|
||||
- [x] Add smooth colouring
|
||||
<!-- * Maybe look into histograms? -->
|
||||
- [ ] Zoom with the Mouse?
|
||||
- [ ] Automatically change scale? Remove the need for the user to deal with the Scale modifier
|
Loading…
Reference in New Issue