diff options
| author | Camil Staps | 2016-06-25 19:27:50 +0200 |
|---|---|---|
| committer | Camil Staps | 2016-06-25 19:28:44 +0200 |
| commit | 6efb9ff65c0670030514d6cd5e9af9380a9289e5 (patch) | |
| tree | 5d4d295b82b9a58c4e87c3e3fcb5b7c4522d7aac | |
| parent | Merge branch 'master' of github.com:camilstaps/Crosswords (diff) | |
Update readme
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | Crosswords.icl | 2 | ||||
| -rw-r--r-- | README.md | 35 |
3 files changed, 37 insertions, 1 deletions
@@ -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 @@ -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 & License + +Copyright © 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 |