aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRaph Levien <raph@google.com>2013-10-11 10:33:29 +0200
committerRaph Levien <raph@google.com>2013-10-11 10:33:29 +0200
commit7efdf8e114cd4667389605df5a1b5ed498ce0386 (patch)
tree20264e1af72028f03f75ed894996630e3dfdddc6
parent04163a87d098f14e890c2a3fd240af7f09099711 (diff)
downloadsrc-7efdf8e114cd4667389605df5a1b5ed498ce0386.tar.gz
Cleanup of README
Refer to brotli/ subdirectory (explicitly naming the license) and clean up a few other things in the README text.
-rw-r--r--README15
1 files changed, 12 insertions, 3 deletions
diff --git a/README b/README
index a1b4f63..df97cc2 100644
--- a/README
+++ b/README
@@ -1,5 +1,14 @@
-This is a README for the font compression reference code. It’s very rough in
-this snapshot, but will be cleaned up some for public release.
+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.
+
+src/ contains prototype Java code for compressing fonts.
+
+cpp/ contains prototype C++ code for decompressing fonts.
+
+docs/ contains documents describing the proposed compression format.
= How to run the compression test tool =
@@ -145,7 +154,7 @@ 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
+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.