Added readme
This commit is contained in:
parent
357c57f384
commit
99ecba369c
25
README.md
Normal file
25
README.md
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
# Gordle
|
||||||
|
|
||||||
|
Go implementation of Wordle game
|
||||||
|
|
||||||
|
## Building instructions
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://git.dmitriy.icu/dm1sh/gordle
|
||||||
|
cd gordle
|
||||||
|
go mod tidy
|
||||||
|
go build .
|
||||||
|
```
|
||||||
|
|
||||||
|
## Running instructions
|
||||||
|
|
||||||
|
```bash
|
||||||
|
% ./gordle --help
|
||||||
|
Usage of ./gordle:
|
||||||
|
-n int
|
||||||
|
Word size (default 5)
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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
|
Loading…
x
Reference in New Issue
Block a user