From 94eb53400a0d0c11340341b3fae11645fbebc62c Mon Sep 17 00:00:00 2001 From: mappu Date: Mon, 31 Dec 2018 16:24:03 +1300 Subject: [PATCH] doc: top-level README.md --- _dist/README.txt => README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) rename _dist/README.txt => README.md (94%) diff --git a/_dist/README.txt b/README.md similarity index 94% rename from _dist/README.txt rename to README.md index 1e600b7..f4c25b4 100644 --- a/_dist/README.txt +++ b/README.md @@ -1,3 +1,5 @@ +# imagequant + Go bindings for libimagequant `libimagequant` is a library for lossy recompression of PNG images to reduce their filesize. It is used by the `pngquant` tool. This `go-imagequant` project is a set of bindings for libimagequant to enable its use from the Go programming language. @@ -6,22 +8,24 @@ This binding was written by hand. The result is somewhat more idiomatic than an Written in Golang -=USAGE= +## Usage Usage example is provided by a sample utility `cmd/gopngquant` which mimics some functionality of the upstream `pngquant`. The sample utility has the following options: -`Usage of gopngquant: +``` +Usage of gopngquant: -In string Input filename -Out string Output filename -Speed int Speed (1 slowest, 10 fastest) (default 3) - -Version` + -Version +``` -=BUILDING= +## Building This package can be installed via go get: `go get code.ivysaur.me/imagequant` [go-get]code.ivysaur.me/imagequant git https://git.ivysaur.me/code.ivysaur.me/imagequant.git[/go-get] @@ -32,11 +36,11 @@ This is a CGO package and requires a C compiler installed. However, if you use ` The `imagequant.go` file also declares a number of `CFLAGS` for GCC that allow the included libimagequant (2.8 git-a425e83) to build in an optimal way without using the upstream configure/make scripts. -=LICENSE= +## License I am releasing this binding under the ISC license, however, `libimagequant` itself is released under GPLv3-or-later and/or commercial licenses. You must comply with the terms of such a license when using this binding in a Go project. -=CHANGELOG= +## Changelog 2017-03-03 2.9go1.1 - go-imagequant: Update bundled libimagequant from 2.8.0 to 2.9.0 @@ -46,7 +50,7 @@ I am releasing this binding under the ISC license, however, `libimagequant` itse 2016-11-24 2.8go1.0 - Initial public release -=SEE ALSO= +## See also - Pngquant homepage https://pngquant.org/ - Pngquant source code https://github.com/pornel/pngquant