dm1sh/gordle
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated readme

Browse Source
This commit is contained in:
Dmitriy Shishkov 2022-07-17 18:42:14 +03:00
parent 846a0575da
commit 096e2f50fc
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -14,8 +14,11 @@ go build .
## Running instructions ## Running instructions
```bash ```bash
% ./gordle --help % ./gordle --help
Usage of ./gordle: Usage of ./gordle:
-f string
Path to dictionary file with words of length -n. If specified, -n must be specified too (if the latter must not be equal to default value (default "./dictionary/5.txt")
-n int -n int
Word size (default 5) Word size (default 5)
``` ```
@ -28,4 +31,4 @@ go test # [-cover]
## Dictionaries ## Dictionaries
To run game you also need dictionary files. By default gordle searches for them in `./dictionary/<n>.txt` file, where `<n>` - number of characters, specified by `-n` flag To run game you also need dictionary files. By default gordle searches for them in `./dictionary/<n>.txt` file, where `<n>` - number of characters, specified by `-n` flag. If want to use custom one, provide in `-f` flag path to txt file with strings separated by new line characters