README.md
author Mikael Berthe <mikael@lilotux.net>
Sat, 07 Apr 2018 22:49:51 +0200
changeset 15 eac7d78ff641
parent 14 f67da1c20c86
child 16 1cde13306e8f
permissions -rw-r--r--
Update gotak import path to fix Travis build Update import path in the gotak subdir so that Travis tests can be played against the Github repository. Also, add missing dependencies to the Travis YAML file.
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
15
eac7d78ff641 Update gotak import path to fix Travis build
Mikael Berthe <mikael@lilotux.net>
parents: 14
diff changeset
    15
Please read the [godoc documentation](https://godoc.org/github.com/McKael/takuzu) for details.
13
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    16
14
f67da1c20c86 Update README
Mikael Berthe <mikael@lilotux.net>
parents: 13
diff changeset
    17
# CLI demo
f67da1c20c86 Update README
Mikael Berthe <mikael@lilotux.net>
parents: 13
diff changeset
    18
13
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    19
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
    20
generate puzzles.
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    21
I haven't written the tool documentation yet.
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    22
14
f67da1c20c86 Update README
Mikael Berthe <mikael@lilotux.net>
parents: 13
diff changeset
    23
To build the gotak CLI utility, you can use
f67da1c20c86 Update README
Mikael Berthe <mikael@lilotux.net>
parents: 13
diff changeset
    24
f67da1c20c86 Update README
Mikael Berthe <mikael@lilotux.net>
parents: 13
diff changeset
    25
```
15
eac7d78ff641 Update gotak import path to fix Travis build
Mikael Berthe <mikael@lilotux.net>
parents: 14
diff changeset
    26
go get github.com/takuzu/gotak
14
f67da1c20c86 Update README
Mikael Berthe <mikael@lilotux.net>
parents: 13
diff changeset
    27
```
f67da1c20c86 Update README
Mikael Berthe <mikael@lilotux.net>
parents: 13
diff changeset
    28
15
eac7d78ff641 Update gotak import path to fix Travis build
Mikael Berthe <mikael@lilotux.net>
parents: 14
diff changeset
    29
(If you use the Mercurial repository, you have to update the import path manually.)
14
f67da1c20c86 Update README
Mikael Berthe <mikael@lilotux.net>
parents: 13
diff changeset
    30
f67da1c20c86 Update README
Mikael Berthe <mikael@lilotux.net>
parents: 13
diff changeset
    31
# Online puzzle demo
f67da1c20c86 Update README
Mikael Berthe <mikael@lilotux.net>
parents: 13
diff changeset
    32
13
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    33
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
    34
written in Go using [GopehJS](https://github.com/gopherjs/gopherjs).
923ce3e425cd Add README and Travis file
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    35
(On mobile, works best with Chrome.  On a computer, I've tested it with both Firefox and Chrome.)