Add README and Travis file
authorMikael Berthe <mikael@lilotux.net>
Sat, 07 Apr 2018 22:28:50 +0200
changeset 13 923ce3e425cd
parent 12 37fd81bab065
child 14 f67da1c20c86
Add README and Travis file Add stuff for the Github mirror (README, Travis file and gitignore files).
.gitignore
.travis.yml
LICENSE.txt
README.md
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/.gitignore	Sat Apr 07 22:28:50 2018 +0200
@@ -0,0 +1,1 @@
+.hgignore
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/.travis.yml	Sat Apr 07 22:28:50 2018 +0200
@@ -0,0 +1,16 @@
+language: go
+go:
+- "1.7"
+- "1.8"
+- "1.9"
+- "1.10"
+- master
+matrix:
+  allow_failures:
+    - go: master
+  fast_finish: true
+branches:
+  only:
+  - master
+install:
+- go get github.com/spf13/pflag
--- a/LICENSE.txt	Mon Aug 28 16:10:21 2017 +0200
+++ b/LICENSE.txt	Sat Apr 07 22:28:50 2018 +0200
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (C) 2016 Mikael Berthe <mikael@lilotux.net>
+Copyright (C) 2016-2017 Mikael Berthe <mikael@lilotux.net>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Sat Apr 07 22:28:50 2018 +0200
@@ -0,0 +1,23 @@
+# 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.
+
+This project also contains a command line utility, named `gotak`, to solve or
+generate puzzles.
+I haven't written the tool documentation yet.
+
+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.)