README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

# Crosswords
Crossword generator tool

![Example](http://i.stack.imgur.com/I5r7L.png)

### 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]
* 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])

### Installation

    $ clm -I $CLEAN_HOME/lib/ArgEnv -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. The example above was created with the words
`newspaper`, `crossword`, `english` and `puzzling`.

    $ ./cwgen [dictionary.txt] < words.txt > cw-gen.tex
    $ pdflatex cw.tex

Remove `\PuzzleSolution[true]` from `cw.tex` to not show the solution in the
result.

### Author &amp; License

Copyright &copy; 2016 [Camil Staps][camilstaps]. Licensed under MIT, See the
`LICENSE` file for details.

### Acknowledgements

* `dict/wordsEn.txt`: compiled from
  [SIL International](http://www-01.sil.org/linguistics/wordlists/english/)
  (only words with 3-10 characters were kept)

[camilstaps]: https://camilstaps.nl
[clean]: http://clean.cs.ru.nl
[crossword]: http://ctan.org/pkg/crossword
[opentaal]: http://www.opentaal.org/bestanden