File: README.rdoc

package info (click to toggle)
ruby-oily-png 1.2.1~dfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, stretch
  • size: 592 kB
  • ctags: 119
  • sloc: ansic: 975; ruby: 395; makefile: 25
file content (26 lines) | stat: -rw-r--r-- 1,135 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
= OilyPNG {<img src="https://travis-ci.org/wvanbergen/oily_png.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/wvanbergen/oily_png]

OilyPNG is a Ruby C extension to speed up the pure Ruby ChunkyPNG library. It is a standalone
module, so it does not require LibPNG, ImageMagick or any other library. Currently it has an 
alternative implementation of decoding and encoding PNGs, making these operations much 
faster, especially for PNG images that apply filtering.

Performance comparison: http://gist.github.com/611255

*Warning*: this is my first C code in years. It may blow up your PC after leaking memory all
over the place, killing a kitten in the process. You have been warned.

== Usage

1. First install the gem and make it available to your project.
2. Use require "oily_png" instead of require "chunky_png"
3. Presto! Now use ChunkyPNG as you normally would and get an instant speedup. 

See http://github.com/wvanbergen/chunky_png/wiki for more information on how to use the
ChunkyPNG API.

== About

License: MIT (see LICENSE)

This C module is written by Willem van Bergen with help from Dirkjan Bussink.