Add README.md and LICENSE
[mandelwow.git] / README.md
1 # MandelWow
2
3 ## Overview
4
5 MandelWow is a generalized version of Mandelbrot & Julia in which both C and Z0 vary in a 4-dimensional space.
6 In each frame, we render a 3D slice of the MandelWow, varying the remaining dimension through time.
7
8 I wrote this hack to learn Rust & basic GLSL. Mind the mess.
9
10
11 ## Building from source
12
13 Install cargo, then simply type:
14
15 ```
16 cargo run --release
17 ```
18
19
20 ## Requirements
21
22 Requires OpenGL 3.1. Should perform well on reasonably modern hardware.
23 Tested on Linux with Intel HD Graphics 4000 (Ivy Bridge) and NVidia GTX 970.
24
25 ## License
26
27 This project is GPL 3.0.
28 The support/ directory contains some code forked from Glium, which was originally Apache 2.0.