aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
index d32372b..e0108e4 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,26 @@
# Mandelbrot set visualizer
+
+A visualizer for the [Mandelbrot Set](https://en.wikipedia.org/wiki/Mandelbrot_set).
+
+## Dependencies
+
+- [SDL2](https://www.libsdl.org/) for the graphics
+
+## Install
+
+SDL2: `sudo apt install libsdl2-dev`
+
+## Usage
+
+1. compile: `make all`
+2. run: `./mandel`
+
+## TODO
+
+- [ ] Create color spectrum.
+- [ ] Smooth shading for out of set iteration colors.
+- [ ] Draw to bmp image.
+- [ ] Create pixel array and update the render line by line.
+- [ ] Display coordinates and other useful info.
+- [ ] Computation done in parallel.
+- [ ] Command line options