~sschwarzer/sudoku-solver

940ba6af79980a3e50f0fd47f3e92264c48f7dc7 — Stefan Schwarzer 1 year, 13 days ago 6af7ae9
Explain how to render dot files
1 files changed, 20 insertions(+), 12 deletions(-)

M README.md
M README.md => README.md +20 -12
@@ 4,7 4,8 @@ Sudoku solver
## Overwiew

This repository implements a simple [Sudoku][1] solver, written in
[Racket][2] .
[Racket][2]. Different from most other solvers, this one can generate
a [GraphViz][3] [dot file][4] that shows the solution process.

After installing the package `sudoku-solver` (see below for installation
instructions), you can run the solver on an input file with


@@ 97,16 98,21 @@ sudoku-solver [ <option> ... ] <file-path>
  --help, -h : Show this help
```

Here's an example for the `--progress-dot-file` output turned into a
[PDF file][3].
Here's an example for the `--progress-dot-file` output turned into a [PDF
file][5]. If you have GraphViz installed, you can turn a dot into a PDF file
with
```
$ dot -T pdf -o output-file.pdf input-file.dot
```
For most graphs, you'll need a PDF viewer that can handle large files.

Enter [tickets][4] for bugs and improvement suggestions on Sourcehut.
Enter [tickets][6] for bugs and improvement suggestions on Sourcehut.

## Installation

### With Racket

If you have Racket installed, you can install the [package][5] with
If you have Racket installed, you can install the [package][7] with
```
$ raco pkg install sudoku-solver
```


@@ 115,16 121,18 @@ and run the program with
$ racket -l games/sudoku-solver -- [options] <file-path>
```

The actual solver is in [games/sudoku-solver/solver.rkt][6].
The actual solver is in [games/sudoku-solver/solver.rkt][8].

### Without Racket

There are [precompiled binaries][7] for different platforms.
There are [precompiled binaries][9] for different platforms.

[1]: https://en.wikipedia.org/wiki/Sudoku
[2]: https://racket-lang.org
[3]: games/sudoku-solver/examples/wikipedia_article_solution.pdf
[4]: https://todo.sr.ht/~sschwarzer/sudoku-solver
[5]: https://pkgs.racket-lang.org/package/sudoku-solver
[6]: games/sudoku-solver/solver.rkt
[7]: https://releases.sschwarzer.net/sudoku-solver/
[3]: https://graphviz.org/
[4]: https://graphviz.org/doc/info/command.html
[5]: games/sudoku-solver/examples/wikipedia_article_solution.pdf
[6]: https://todo.sr.ht/~sschwarzer/sudoku-solver
[7]: https://pkgs.racket-lang.org/package/sudoku-solver
[8]: games/sudoku-solver/solver.rkt
[9]: https://releases.sschwarzer.net/sudoku-solver/