# HG changeset patch # User Mikael Berthe # Date 1523137025 -7200 # Node ID db2eacbac9b635b8f0d279103bea3faf37271cd2 # Parent 1110dfef896427ed9cc6465e7d941b708082d040 README: Add gotak examples diff -r 1110dfef8964 -r db2eacbac9b6 README.md --- a/README.md Sat Apr 07 23:17:21 2018 +0200 +++ b/README.md Sat Apr 07 23:37:05 2018 +0200 @@ -31,6 +31,49 @@ Pre-built binaries are available on the [Github Release page](https://github.com/McKael/takuzu/releases). +The utility was written for personal use and is not very user-friendly, but it +should be reasonably efficient (I've been able to generate boards up to 50x50). +Here are a few examples to get started: + +Build new 6x6 puzzle: +``` +% gotak --new 6 + +. . . . . . +0 . . . . 0 +. . 1 . . . +. . . . 1 . +1 . 0 0 . . +1 . . . . . +``` + +Solve the board: +``` +% gotak --board ......0....0..1.......1.1.00..1..... + +. . . . . . +0 . . . . 0 +. . 1 . . . +. . . . 1 . +1 . 0 0 . . +1 . . . . . + + +0 1 1 0 0 1 +0 1 0 1 1 0 +1 0 1 1 0 0 +0 0 1 0 1 1 +1 1 0 0 1 0 +1 0 0 1 0 1 +``` + +(You can get the board string with the `--out` flag when generating new puzzles.) + +Create a PDF with a takuzu puzzle: +``` +% gotak --new 10 --to-pdf /tmp/takuzu.pdf +``` + # Online puzzle demo This library is used by GotakJS, an [online takuzu puzzle game](https://lilotux.net/~mikael/takuzu/),