aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 35 insertions, 0 deletions
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