initial

USAGE.md

@@ -0,0 +1,42 @@
+# Crossword Builder — Usage
+
+Generate a maths crossword PDF from a list of number words.
+
+## Basic Usage
+
+```bash
+python3 crossword_builder.py EIGHT THREE NINE SEVEN TEN FOUR
+```
+
+## Options
+
+| Flag | Description | Default |
+|------|-------------|---------|
+| `--output <file>` | Output PDF filename | `crossword.pdf` |
+| `--clues "WORD:eq,..."` | Custom equations per word | Auto-generated |
+| `--seed <int>` | Random seed for reproducible layouts | None |
+
+Pass a single integer to pick that many random number words:
+
+```bash
+python3 crossword_builder.py 6
+```
+
+## Examples
+
+```bash
+# Basic
+python3 crossword_builder.py EIGHT THREE NINE SEVEN
+
+# Custom output file
+python3 crossword_builder.py --output my_puzzle.pdf EIGHT THREE NINE SEVEN
+
+# Custom clues
+python3 crossword_builder.py --clues "EIGHT:4+4,THREE:9-6" EIGHT THREE NINE
+
+# Reproducible layout
+python3 crossword_builder.py --seed 42 EIGHT THREE NINE SEVEN
+
+# Combined
+python3 crossword_builder.py --output my_puzzle.pdf --seed 42 EIGHT THREE NINE SEVEN
+```