From ea094bf6abe23b1091982c28bde98643dc135e92 Mon Sep 17 00:00:00 2001
From: Adrian Kummerlaender
Date: Sun, 22 May 2016 22:19:42 +0200
Subject: Add README.md

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 README.md

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/)
-- 
cgit v1.2.3