third_party/woff2/README.md

   1 This is a README for the font compression reference code. There are several
   2 compression related modules in this repository.
   3
   4 brotli/ contains reference code for the Brotli byte-level compression
   5 algorithm. Note that it is licensed under an Apache 2 license.
   6
   7 src/ contains the C++ code for compressing and decompressing fonts.
   8
   9 # Build & Run
  10
  11 This document documents how to run the compression reference code. At this
  12 writing, the code, while it is intended to produce a bytestream that can be
  13 reconstructed into a working font, the reference decompression code is not
  14 done, and the exact format of that bytestream is subject to change.
  15
  16 ## Build
  17
  18 On a standard Unix-style environment:
  19
  20 ```
  21 git clone https://github.com/google/woff2.git
  22 cd woff2
  23 git submodule init
  24 git submodule update
  25 make clean all
  26 ```
  27
  28 ## Run
  29
  30 ```
  31 woff2_compress myfont.ttf
  32 woff2_decompress myfont.woff2
  33 ```
  34
  35 # References
  36
  37 http://www.w3.org/TR/WOFF2/
  38 http://www.w3.org/Submission/MTX/
  39
  40 Also please refer to documents (currently Google Docs):
  41
  42 WOFF Ultra Condensed file format: proposals and discussion of wire format
  43 issues (PDF is in docs/ directory)
  44
  45 WIFF Ultra Condensed: more discussion of results and compression techniques.
  46 This tool was used to prepare the data in that document.