~sschwarzer/sudoku-solver

3d6881c5a4c4c6f57f4048b2c3bdf64d038e0baf — Stefan Schwarzer 1 year, 22 days ago 86a8d8d
Clean up `README.md`

In particular, use distinct "Overview" and "Installation" sections.
1 files changed, 27 insertions(+), 4 deletions(-)

M README.md
M README.md => README.md +27 -4
@@ 1,11 1,13 @@
Sudoku solver
=============

## Overwiew

This repository implements a simple [Sudoku][1] solver, written in
[Racket][2] .

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


@@ 98,10 100,31 @@ sudoku-solver [ <option> ... ] <file-path>
Here's an example for the `--progress-dot-file` output turned into a
[PDF file][3].

The actual solver is in `games/sudoku-solver/solver.rkt`.
Enter [tickets][4] for bugs and improvement suggestions on Sourcehut.

## Installation

### With Racket

If you have Racket installed, you can install the [package][5] with
```
$ raco pkg install sudoku-solver
```
and run the program with
```
$ racket -l games/sudoku-solver -- [options] <file-path>
```

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

### Without Racket

Use https://todo.sr.ht/~sschwarzer/sudoku-solver for tickets.
There are [precompiled binaries][7] 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/