Add README.mdHEADmaster

1 files changed, 20 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ed6476d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# voronoi
+
+...an exploration of Voronoi diagrams in C++.
+
+Execute `voronoi.sh` to generate an animated GIF of the transition between a Voronoi diagram based on the Manhattan metric and one based on the Euclidean metric.
+
+An animation of the unit sphere may be generated using `unit_circle.sh`.
+
+Freely available under the terms of the MIT license.
+
+## Example
+
+![Transition between the Manhattan and Euclidean metric](https://static.kummerlaender.eu/media/voronoi_cycle.gif)
+
+## Dependencies
+
+* C++ compiler with support for C++14
+* [CMake](https://cmake.org/)
+* [Imagemagick](http://www.imagemagick.org/)
+* [fish](http://fishshell.com/)