From 6efb9ff65c0670030514d6cd5e9af9380a9289e5 Mon Sep 17 00:00:00 2001
From: Camil Staps
Date: Sat, 25 Jun 2016 19:27:50 +0200
Subject: Update readme

---
 .gitignore     |  1 +
 Crosswords.icl |  2 +-
 README.md      | 35 +++++++++++++++++++++++++++++++++++
 3 files changed, 37 insertions(+), 1 deletion(-)

diff --git a/.gitignore b/.gitignore
index 9a196f5..5f73f03 100644
--- a/.gitignore
+++ b/.gitignore
@@ -21,3 +21,4 @@ sapl/
 
 # Custom
 cw-gen.tex
+dictionary.txt
diff --git a/Crosswords.icl b/Crosswords.icl
index 7489545..21cb2c4 100644
--- a/Crosswords.icl
+++ b/Crosswords.icl
@@ -24,7 +24,7 @@ instance zero Crossword where zero = []
 
 :: RandomSeed :== Int
 
-dictionary :== "dict-3-6.txt"
+dictionary :== "dictionary.txt"
 
 // Reads words from stdin (end with empty line) and builds a crossword that
 // connects all these words (if possible); then fills the crossword with words
diff --git a/README.md b/README.md
index d6f4778..ea79785 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,37 @@
 # Crosswords
 Crossword generator tool
+
+### Features
+
+* Generates a crossword puzzle that contains as many given words as possible
+* Fills up empty space with words from a dictionary
+
+### Prerequisites
+
+* [Clean][clean]
+* TeX
+* The [crossword][crossword] TeX package for `cwpuzzle.dtx`
+* A dictionary for your language (one word per line, for Dutch you can have a
+  look at [OpenTaal][opentaal])
+
+### Installation
+
+    $ clm -I $CLEAN_HOME/lib/MersenneTwister -b -h 100M Crosswords -o cwgen
+
+### Usage example
+
+Words are read from stdin, ended with an empty line or `EOF`, and of course
+from the dictionary installed.
+
+    $ ./cwgen < words.txt > cw-gen.tex
+    $ pdftex cw.tex
+
+### Author &amp; License
+
+Copyright &copy; 2016 [Camil Staps][camilstaps]. Licensed under MIT, See the
+`LICENSE` file for details.
+
+[camilstaps]: https://camilstaps.nl
+[clean]: http://clean.cs.ru.nl
+[crossword]: http://ctan.org/pkg/crossword
+[opentaal]: http://www.opentaal.org/bestanden
-- 
cgit v1.2.3