diff --git a/README.md b/README.md index a05b92e..fc47fdd 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,14 @@ # uckf -A deeply unsatisfying word search. \ No newline at end of file +A deeply unsatisfying word search. + +## Usage + +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 + +## Notes + +This algorithm converges much more quickly than I expected.