README.md
author Mikael Berthe <mikael@lilotux.net>
Sat, 07 Apr 2018 22:32:47 +0200
changeset 14 f67da1c20c86
parent 13 923ce3e425cd
child 15 eac7d78ff641
permissions -rw-r--r--
Update README

# takuzu

Golang takuzu library

[![godoc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat)](https://godoc.org/github.com/McKael/takuzu)
[![license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://raw.githubusercontent.com/McKael/takuzu/master/LICENSE)
[![Build Status](https://travis-ci.org/McKael/takuzu.svg?branch=master)](https://travis-ci.org/McKael/takuzu)

This repository contains a [Go](https://golang.org/) library package that
provides functions to solve, build or validate takuzu puzzles.

- Mercurial repository: https://hg.lilotux.net/golang/mikael/takuzu/
- Github mirror: https://github.com/McKael/takuzu/

Please read the [godoc documentation]](https://godoc.org/github.com/McKael/takuzu) for details.

# CLI demo

This project also contains a command line utility, named `gotak`, to solve or
generate puzzles.
I haven't written the tool documentation yet.

To build the gotak CLI utility, you can use

```
go get https://hg.lilotux.net/golang/mikael/takuzu/gotak
```

(If you use the Github mirror, you'll have to update the import path manually.)

# Online puzzle demo

This library is used by GotakJS, an [online takuzu puzzle game](https://lilotux.net/~mikael/takuzu/),
written in Go using [GopehJS](https://github.com/gopherjs/gopherjs).
(On mobile, works best with Chrome.  On a computer, I've tested it with both Firefox and Chrome.)