From 7978a3800be3bb6d0c30a117bb55e71b4795310a Mon Sep 17 00:00:00 2001
From: fooflington <foo@mafoo.org.uk>
Date: Sat, 18 Aug 2018 16:09:53 +0100
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0b3e26b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+Wordsearch generator
+====================
+
+This is a Wordsearch generator written in C largely as an exercise in remembering how to use C having originally implemented it in Java (see https://github.com/fooflington/wordsearch-c).
+
+Compiling
+---------
+
+Generally you'll probably want the *Release* version which has Optimisation enabled:
+
+```bash
+cd Release && make
+```
+
+This will drop a `wordsearch` executable
+
+Running
+-------
+
+```
+Usage: wordsearch <height> <width> [ words ... ]
+```
+
+For example:
+
+```
+$ ./wordsearch 15 15 gaping panicky lock purple geese massive judge hateful
+```
+
+For an existing list of words, the following form can be useful:
+
+```
+$ cat file.txt | xargs ./wordsearch 15 15
+```
+
+There are some example wordlists included in `tests`.