From b4a85386c454b829de34dff92935ba74b7d9a78f Mon Sep 17 00:00:00 2001 From: Camil Staps Date: Sat, 25 Jun 2016 20:12:39 +0200 Subject: Update readme --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d656ba1..2d42e33 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Crosswords Crossword generator tool +![Example](http://i.stack.imgur.com/Wc8e2.png) + ### Features * Generates a crossword puzzle that contains as many given words as possible @@ -9,8 +11,8 @@ Crossword generator tool ### Prerequisites * [Clean][clean] -* TeX -* The [crossword][crossword] TeX package for `cwpuzzle.dtx` +* LaTeX +* The [crossword][crossword] LaTeX package for `cwpuzzle.dtx` * A dictionary for your language (one word per line, for Dutch you can have a look at [OpenTaal][opentaal]) @@ -21,10 +23,14 @@ Crossword generator tool ### Usage example Words are read from stdin, ended with an empty line or `EOF`, and of course -from the dictionary installed. +from the dictionary installed. The example above was created with the words +`crossword`, `english` and `puzzling`. $ ./cwgen < words.txt > cw-gen.tex - $ pdftex cw.tex + $ pdflatex cw.tex + +Remove `\PuzzleSolution[true]` from `cw.tex` to not show the solution in the +result. ### Author & License -- cgit v1.2.3