Documentation: Update sfntly URL and formatting

Change-Id: I1c821d7e20c7428f34495aed32f6cc091fd0109b
This commit is contained in:
Kartik Mistry
2018-05-04 16:36:04 +05:30
committed by jenkins-bot
parent 79ac74e677
commit d00ddb89fd

View File

@@ -1,9 +1,10 @@
This is font repository for Universal Language Selector. These fonts are used by jquery.webfonts This is font repository for Universal Language Selector. These fonts are used
to deliver on demand or based on users preferences. There is a script named "compile-font-repo.php" by jquery.webfonts to deliver on demand or based on users preferences. There is
to generate the font repository in JavaScript syntax. It reads this font.ini files. a script named "compile-font-repo.php" to generate the font repository in
JavaScript syntax. It reads this font.ini files.
Each folder contains a font.ini file, which is the description about the font. The fields in the font.ini Each folder contains a font.ini file, which is the description about the font.
is described below. Use ';' to add any comments. The fields in the font.ini is described below. Use ';' to add any comments.
languages languages
--------- ---------
@@ -35,14 +36,16 @@ Upstream location of font to download.
formats formats
------- -------
If there are style variants, font.ini should contain file names for each variants(bold, italic etc). Otherwise, If there are style variants, font.ini should contain file names for each
based on the extension of files, the font compilation script can pick it up. variants(bold, italic etc). Otherwise, based on the extension of files, the
font compilation script can pick it up.
Preparing font formats Preparing font formats
----------------------- -----------------------
1. From the upstream releases, take the TTF versions. 1. From the upstream releases, take the TTF versions.
2. To generate woff format, get https://github.com/googlei18n/sfntly 2. To generate woff format, get: https://github.com/rillig/sfntly
3. Use https://github.com/google/woff2 to generate woff2 from ttf. This will produce a compressed woff2 file. 3. Use https://github.com/google/woff2 to generate woff2 from ttf. This will
Modern browsers support this format. produce a compressed woff2 file. Modern browsers support this format.
4. The eot file format is used only by older IE, but it can be generated using sfntly. Make sure to use -mtx flag to get 4. The eot file format is used only by older IE, but it can be generated using
enhanced compression. sfntly. Make sure to use -mtx flag to get enhanced compression.