From cb63c009cc3bf5f28702b781b19d6e34fb8bdd44 Mon Sep 17 00:00:00 2001
From: Kistaro Windrider <kistaro@gmail.com>
Date: Mon, 5 Feb 2024 19:16:41 -0800
Subject: [PATCH] instructions

---
 README.md | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

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.