Document flags (correctly).

This commit is contained in:
Kistaro Windrider 2024-02-05 20:04:51 -08:00
parent 691c59462a
commit ff9c8315c1
Signed by: kistaro
SSH Key Fingerprint: SHA256:TBE2ynfmJqsAf0CP6gsflA0q5X5wD5fVKWPsZ7eVUg8

View File

@ -7,7 +7,13 @@ A deeply unsatisfying word search.
1. [install the Go compiler](https://go.dev/dl/) if you don't have it yet
2. clone this repo (`git clone https://git.chromaticdragon.app/kistaro/uckf.git`)
3. `go run uckf.go`
4. you can use `-s` to specify a different grid size; for example, `go run uckf.go -s 100` will create a 100x100 unsatisfying word search
4. you can use `-n` to specify a different grid size; for example, `go run uckf.go -n 100` will create a 100x100 unsatisfying word search
### Flags
* `-n <int>` -- use a grid with edges of length n
* `-s` -- summary mode; do not print intermediate grids, only summaries
* `-r=false` -- suppress final result (only print a summary for that)
## Notes