libwebp

mirror of https://github.com/webmproject/libwebp.git synced 2024-12-26 13:48:21 +01:00

History

James Zern 560394798f webp-container-spec: clarify background clear on loop at the beginning of the loop there's an implicit clear of the entire canvas to the background (or application defined) color. this avoids adding the final composited frame to the first. Change-Id: Ia3a52cf4482c6176334a5c9c99a0ddd07d1776e7		2015-02-04 18:07:00 -08:00
..
README	Add kramdown version information to README	2012-06-20 14:17:36 -07:00
template.html	Lossless WebP doc largely ported to markdown text.	2012-06-15 14:52:57 -07:00
TODO	Update the WebP Container Spec.	2012-06-21 16:04:58 -07:00
webp-container-spec.txt	webp-container-spec: clarify background clear on loop	2015-02-04 18:07:00 -08:00
webp-lossless-bitstream-spec.txt	Amend the lossless spec according to issue #205 , #206 and #224	2014-09-18 08:21:02 +02:00

README

Generate libwebp Container Spec Docs from Text Source
=====================================================

HTML generation requires kramdown [1], easily installed as a
rubygem [2].  Rubygems installation should satisfy dependencies
automatically.

[1]: http://kramdown.rubyforge.org/
[2]: http://rubygems.org/

HTML generation can then be done from the project root:

$ kramdown doc/webp-container-spec.txt --template doc/template.html > \
  doc/output/webp-container-spec.html

kramdown can optionally syntax highlight code blocks, using CodeRay [3],
a dependency of kramdown that rubygems will install automatically.  The
following will apply inline CSS styling; an external stylesheet is not
needed.

$ kramdown doc/webp-lossless-bitstream-spec.txt --template \
  doc/template.html --coderay-css style --coderay-line-numbers ' ' \
  --coderay-default-lang c > \
  doc/output/webp-lossless-bitstream-spec.html

Optimally, use kramdown 0.13.7 or newer if syntax highlighting desired.

[3]: http://coderay.rubychan.de/