add readme and demo image

1 files changed, 14 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e20a0ff
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+### Wave function collapse
+
+This an implementation of very primitive tile-based wave function collapse.
+It uses tiles to generate an image, similar to this:
+![Demo of the program](demo/demo.png)
+
+It generates the tiles as ppm, then generates the image, similar to the demo image as ppm. There is a script to turn the ppm files into png using imagemagick.
+
+All files including the tiles are saved in the files directory
+
+### Build
+
+To build use `./build.sh`
+To build and run use `./build.sh run`