diff --git a/README.md b/README.md new file mode 100644 index 0000000..6861dff --- /dev/null +++ b/README.md @@ -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/.txt` file, where `` - number of characters, specified by `-n` flag