libwebp

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

History

James Zern 8d510751da webp-container-spec: correct frame duration=0 note the interpretation of a 0 duration depends on the implementation; merging of multiple frames isn't guaranteed, some may enforce a minimum duration. BUG=webp:380 Change-Id: Idf592049d2092e4cc5cfb2e4c59ddbc91bd52f9c (cherry picked from commit `71c39a06c8`)		2018-04-20 19:59:21 -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	webp-container-spec: correct frame duration=0 note	2018-04-20 15:23:12 -07:00
webp-lossless-bitstream-spec.txt	doc: use two's complement explicitly for uint8->int8 conversion	2016-09-05 10:57:56 -07: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/