GabrielTofvesson/sudoku
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add compilation instructions and TODO to README

Browse Source
This commit is contained in:
Gabriel Tofvesson 2020-02-28 04:47:30 +01:00
parent 78b17e208d
commit 9424a3eae9
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -4,7 +4,9 @@ A simple sudoku problem solver
## File format ## File format
The sudoku solver accepts a file for the following format: The sudoku solver accepts a file for the following format:
* Each row consists of 9 characters (+ newline) * Each row consists of 9 characters (+ newline)
* Each character on a row (aside from newline) must be '0'-'9' or ' ' (if value is unknown) * Each character on a row (aside from newline) must be '0'-'9' or ' ' (if value is unknown)
* There must be a total of 9 rows * There must be a total of 9 rows
For example, a file might look as follows: For example, a file might look as follows:
@ -33,3 +35,14 @@ or
8 12345 7 8 12345 7
912345678 912345678
``` ```
## Test
To test the functionality, simply run `gcc -o sudoku main.c board.c`, then
`./sudoku [filename]`, where the given file is formatted according to the
aforementioned specifications.
## TODO
* Speculative value placement
* Optimizations