README.md
author Mikael Berthe <mikael@lilotux.net>
Sat, 07 Apr 2018 22:28:50 +0200
changeset 13 923ce3e425cd
child 14 f67da1c20c86
permissions -rw-r--r--
Add README and Travis file Add stuff for the Github mirror (README, Travis file and gitignore files).
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
13
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     1
# takuzu
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     2
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     3
Golang takuzu library
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     4
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     5
[![godoc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat)](https://godoc.org/github.com/McKael/takuzu)
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     6
[![license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://raw.githubusercontent.com/McKael/takuzu/master/LICENSE)
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     7
[![Build Status](https://travis-ci.org/McKael/takuzu.svg?branch=master)](https://travis-ci.org/McKael/takuzu)
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     8
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     9
This repository contains a [Go](https://golang.org/) library package that
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    10
provides functions to solve, build or validate takuzu puzzles.
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    11
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    12
- Mercurial repository: https://hg.lilotux.net/golang/mikael/takuzu/
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    13
- Github mirror: https://github.com/McKael/takuzu/
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    14
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    15
Please read the [godoc documentation]](https://godoc.org/github.com/McKael/takuzu) for details.
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    16
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    17
This project also contains a command line utility, named `gotak`, to solve or
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    18
generate puzzles.
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    19
I haven't written the tool documentation yet.
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    20
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    21
This library is used by GotakJS, an [online takuzu puzzle game](https://lilotux.net/~mikael/takuzu/),
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    22
written in Go using [GopehJS](https://github.com/gopherjs/gopherjs).
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    23
(On mobile, works best with Chrome.  On a computer, I've tested it with both Firefox and Chrome.)