Commit 6ef2bf555a42402f9ae453b3213326f87bcc40e8
Parent: 0f8ceecf8924fd4e55adcafda36420981b8df0f5
Author: mcol <mcol@posteo.net>
Date: 2022-04-03 12:44:08 +0100
Committer: mcol <mcol@posteo.net>
Committed: 2022-04-03 12:45:02 +0100

add usage note to readme

readme.rst Modified

@@ -6,3 +6,16 @@
 
 The puzzle in ``puzzle_1.txt`` is in the public domain, and is taken from
 Wikipedia.
+
+Usage
+-----
+
+The script uses ``runhaskell`` as an interpreter but doesn't use any third
+party libraries.
+
+./sudoku.hs puzzle_1.txt
+./sudoku.hs  # Defaults to puzzle_1.text
+
+Where the file passed contains a sudoku puzzle encoded in spaces and digits,
+ignoring all other characters including newlines etc. The script extracts the
+digits and spaces and maps those onto the puzzle grid.