Commit allHEADmaster

1 files changed, 27 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..9600ea5
--- /dev/null
+++ b/README
@@ -0,0 +1,27 @@
+eow
+---
+eow is a little game where you can guess the ending of words. For instance, you 
+may get: ti___, man___, cas___, and you have to guess "tle". Inspired by a 
+question I saw on The 1% Show one evening.
+
+How to compile and run
+----------------------
+Tested on Arch Linux, with the `foot` terminal emulator.
+
+Run:
+    git clone https://gabbott.dev/eow
+	git clone https://gabbott.dev/strarr 
+	cd eow/
+	./install.sh
+
+Then run `make` to make the program, and execute with:
+	./eow
+
+License
+-------
+Licensed under BSD 3-Clause.
+
+Words list
+----------
+The words list is gotten from dwyl (https://github.com/dwyl/english-words).
+The only thing I did was remove \r to make it work on Linux.