zumun/woff2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

rename README to be markdown

Browse Source
This commit is contained in:
Roderick Sheeter
2014-11-18 12:58:30 -08:00
parent 2b754136eb
commit b79469c87d
1 changed files with 0 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README
-49
View File
@@ -1,49 +0,0 @@
This is a README for the font compression reference code. There are several
compression related modules in this repository.
brotli/ contains reference code for the Brotli byte-level compression
algorithm. Note that it is licensed under an Apache 2 license.
woff2/ contains the C++ code for compressing and decompressing fonts.
docs/ contains documents describing the proposed compression format.
= Build & Run =
This document documents how to run the compression reference code. At this
writing, the code, while it is intended to produce a bytestream that can be
reconstructed into a working font, the reference decompression code is not
done, and the exact format of that bytestream is subject to change.
== Build ==
On a standard Unix-style environment:
```
git clone https://github.com/google/woff2.git
cd woff2
git submodule init
git submodule update
cd woff2
make clean all
```
== Run ==
```
woff2_compress myfont.ttf
woff2_decompress myfont.woff2
```
= References =
http://www.w3.org/TR/WOFF2/
http://www.w3.org/Submission/MTX/
Also please refer to documents (currently Google Docs):
WOFF Ultra Condensed file format: proposals and discussion of wire format
issues (PDF is in docs/ directory)
WIFF Ultra Condensed: more discussion of results and compression techniques.
This tool was used to prepare the data in that document.