code.ivysaur.me/imagequant
1
0
Fork 0
Code Issues Pull Requests Releases 2 Wiki Activity

doc: top-level README.md

Browse Source
This commit is contained in:
mappu 2018-12-31 16:24:03 +13:00
parent 5d2ee53ed0
commit 94eb53400a
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
_dist/README.txt → README.md
View File

@ -1,3 +1,5 @@
# imagequant
Go bindings for libimagequant 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. `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 Written in Golang
=USAGE= ## Usage
Usage example is provided by a sample utility `cmd/gopngquant` which mimics some functionality of the upstream `pngquant`. 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: The sample utility has the following options:
`Usage of gopngquant: ```
Usage of gopngquant:
-In string -In string
Input filename Input filename
-Out string -Out string
Output filename Output filename
-Speed int -Speed int
Speed (1 slowest, 10 fastest) (default 3) 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` 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] [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. 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. 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 2017-03-03 2.9go1.1
- go-imagequant: Update bundled libimagequant from 2.8.0 to 2.9.0 - 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 2016-11-24 2.8go1.0
- Initial public release - Initial public release
=SEE ALSO= ## See also
- Pngquant homepage https://pngquant.org/ - Pngquant homepage https://pngquant.org/
- Pngquant source code https://github.com/pornel/pngquant - Pngquant source code https://github.com/pornel/pngquant