Skip to content

Commit

Permalink
readme: rework instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryp committed Nov 4, 2023
1 parent 9756466 commit 3dcebf0
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,6 @@ zig build run -- 3 3 72..96..3...2.5....8...4.2........6.1.65.38.7.4........3.8.
```
NOTE: The sudoku string has to contain valid clue characters, anything else is considered as an empty cell.

Example with a 4x3 sudoku:
```sh
zig build run -- 4 3 8.9....B.4C.C......3.B9...B5..A8.2...2.4..5........9........7...1B69...32...C47A...B........5........1..A.7...5.87..13...8A.3......2.14.5....8.C
```

Example with a Jigsaw sudoku:
```sh
zig build run -- 3 3 .38.4.1...6.9532......6....97......54..........5..2......6..8...57....6.34.8..... 111111222113444422133455442334455222366657777366559997366659977386858997888888997
```
NOTE: Jigsaw puzzles need a second string that matches each cell with its associated region, so it's like the sudoku string but instead of clues you write the region index

## Controls

| Action | Key |
Expand All @@ -39,3 +28,16 @@ NOTE: Jigsaw puzzles need a second string that matches each cell with its associ
| Fill guesses | H |
| Clear guesses | Shift + H |
| Solve | Enter |

## Examples

### 4x3 sudoku
```sh
zig build run -- 4 3 8.9....B.4C.C......3.B9...B5..A8.2...2.4..5........9........7...1B69...32...C47A...B........5........1..A.7...5.87..13...8A.3......2.14.5....8.C
```

### Jigsaw sudoku
```sh
zig build run -- 3 3 .38.4.1...6.9532......6....97......54..........5..2......6..8...57....6.34.8..... 111111222113444422133455442334455222366657777366559997366659977386858997888888997
```
NOTE: Jigsaw puzzles need a second string that matches each cell with its associated region, so it's like the sudoku string but instead of clues you write the region index

0 comments on commit 3dcebf0

Please sign in to comment.