SliTaz Repositories

1 --- a/README.md

2 +++ b/README.md

3 @@ -14,11 +14,13 @@

4 Oxipng can be downloaded from the [Releases](https://github.com/shssoichiro/oxipng/releases) link on the GitHub page.

5

6 Oxipng can also be installed from Cargo, via the following command:

7 +

8 ```

9 cargo install oxipng

10 ```

11

12 Alternatively, oxipng can be built from source using the latest stable or nightly Rust:

13 +

14 ```

15 git clone https://github.com/shssoichiro/oxipng.git

16 cd oxipng

17 @@ -40,16 +42,19 @@

18 ```

19

20 The most commonly used options are as follows:

21 +

22 * Optimization: `-o 1` through `-o 6`, lower is faster, higher is better compression.

23 The default (`-o 2`) is sufficiently fast on a modern CPU and provides 30-50% compression

24 gains over an unoptimized PNG. `-o 4` is 6 times slower than `-o 2` but can provide 5-10%

25 extra compression over `-o 2`. Using any setting higher than `-o 4` is unlikely

26 to give any extra compression gains and is not recommended.

27 +

28 * Interlacing: `-i 1` will enable [Adam7](https://en.wikipedia.org/wiki/Adam7_algorithm)

29 PNG interlacing on any images that are processed. `-i 0` will remove interlacing from all

30 processed images. Not specifying either will keep the same interlacing state as the

31 input image. Note: Interlacing can add 25-50% to the size of an optimized image. Only use

32 it if you believe the benefits outweight the costs for your use case.

33 +

34 * Strip: Used to remove metadata info from processed images. Used via `--strip [safe,all]`.

35 Can save a few kilobytes if you don't need the metadata. "Safe" removes only metadata that

36 will never affect rendering of the image. "All" removes all metadata that is not critical

37 @@ -94,6 +99,7 @@

38

39 ## Benchmarks

40

41 +```

42 Tested oxipng 1.0.3 (compiled on rustc 1.25.0 (84203cac6 2018-03-25)) against OptiPNG version 0.7.7 on Intel(R) Core(TM) i7-6700HQ CPU @ 2.60GHz with 8 logical cores

43

44

45 @@ -130,3 +136,4 @@

46

47 './target/release/oxipng -o4 -P ./tests/files/rgb_16_should_be_grayscale_8.png' ran

48 4.30x faster than 'optipng -o 4 -simulate ./tests/files/rgb_16_should_be_grayscale_8.png'

49 +```