diff options
author | Ian C <ianc@noddybox.co.uk> | 2018-07-23 09:53:18 +0000 |
---|---|---|
committer | Ian C <ianc@noddybox.co.uk> | 2018-07-23 09:53:18 +0000 |
commit | 7e8404528b5ccd11008663173c900eff3247758c (patch) | |
tree | b2a0e6ab53fe3bd0769675b0a8aaceafa035ece2 /README | |
parent | 71cfb7fbe93b80d52176650b4e67df3140c134cc (diff) |
Updated README with basic usage.
Diffstat (limited to 'README')
-rw-r--r-- | README | 17 |
1 files changed, 17 insertions, 0 deletions
@@ -2,3 +2,20 @@ codeword is released under the GPL v3. See LICENSE for details. words_alpha.txt is released into the public domain. The original source and license is available at https://github.com/dwyl/english-words. + +To use codeword, run it with a text file containing a list of words and a +series of arguments that define whether each character position is a missing +letter (using period), a numbered letter or a fixed letter. + +For instance: + + codeword words_alpha.txt 1 2 w 2 + +To search for a four letter word where 'w' is the third character, the first +charater is a different letter, and the same different letter is used in the +second and fourth character position. + + codeword words_alpha.txt . . w . + +To search for a four letter where the third character is 'w' and all other +characters can be any letter. |