danvics/oxipng
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update readme

Browse source
This commit is contained in:
Joshua Holmer 2016-01-11 11:09:23 -05:00
parent 4138aada34
commit 918da4a49b
1 changed files with 10 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -2,6 +2,14 @@
## Overview
OxiPng is a PNG compression optimizer.
In the typical use case, OxiPng recompresses PNG image files
losslessly and performs PNG integrity checks and corrections.
Future implementation of other features is planned.
## History
OxiPng began as a completely rewrite of the OptiPNG project,
which is assumed to be dead as no commit has been made to it since 2013.
The name has been changed to avoid confusion and potential legal issues.
@ -10,12 +18,6 @@ The core goal of rewriting OptiPNG was to implement multithreading,
which would be very difficult to do within the existing C codebase of OptiPNG.
This also served as an opportunity to choose a more modern, safer language (Rust).
OxiPng is a PNG compression optimizer.
In the typical use case, OxiPng recompresses PNG image files
losslessly and performs PNG integrity checks and corrections.
Future implementation of other features is planned.
## Building
Building OxiPng can be done using the latest stable or nightly Rust with Cargo installed, as follows:
@ -28,6 +30,8 @@ cp target/release/oxipng /usr/local/bin
Please note that zlib is a required build dependency. OxiPng should work with any 1.x version of zlib,
but you are advised to use the latest version (currently 1.2.8) for security and bug fixes.
OxiPng follows Semantic Versioning.
## Usage
OxiPng is a command-line utility. Basic usage looks similar to the following:
@ -52,14 +56,6 @@ Can save a few kilobytes if you don't need the metadata.
More advanced options can be found by running `oxipng -h`.
## Changes
OxiPng attempts to maintain functionality of the original OxiPng as much as possible,
although command line usage may have changed (OxiPng follows semantic versioning).
As OxiPng is in alpha, there are still some features that are missing. All intended features
will be implemented in OxiPng before it moves into beta.
## Contributing
Any contributions are welcome and will be accepted via pull request on GitHub. Bug reports can be