libwebp

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

History

Urvang Joshi 403bfe820c Container spec: Clarify frame disposal - Add a note that disposal only applies to the frame rectangle - Add the formula for alpha-blending. - Note that alpha-blending would occur for the common rectangle - Also note the case when both color profile and disposal are present. Change-Id: I214787dd64453edf3b0cdaff3951015281a32ee4		2013-03-29 11:42:17 -07: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	Container spec: Clarify frame disposal	2013-03-29 11:42:17 -07:00
webp-lossless-bitstream-spec.txt	Formatting fixes in lossless bitstream spec	2013-01-18 14:35:47 -08: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/