Update Xolonium sources to version 4.2

[xonotic/mediasource.git] / fonts / xolonium / README.md

diff --git a/fonts/xolonium/README.md b/fonts/xolonium/README.md
index f9fcf90523e8178bbb349f5213e121ed8b2e8d2e..cf154cdb097959de88276ce101a0398814643c0d 100644 (file)
--- a/fonts/xolonium/README.md
+++ b/fonts/xolonium/README.md
@@ -1,10 +1,61 @@
-The Makefile builds two versions of the fonts.
+Xolonium
+========
 
-The *Public* version is intended for general use,  
-and is licensed under the SIL Open Font License.
+Xolonium is a futuristic typeface, with focus on legibility.
+It provides support for Latin, Greek, and Cyrillic glyph sets,
+and includes various pictograms and emoticons.
 
-The *Xonotic* version is intended for the open source  
-game Xonotic <http://xonotic.org>, and is licensed under  
-the GNU General Public License, with GPL Font Exception.
+Xolonium originated as a custom font for the open-source game
+[Xonotic](https://xonotic.org).
 
-Find both license notices in the *release* directory.
+
+Build
+-----
+
+The fonts can be compiled with the provided Makefile,
+which runs the scripts from the `tools` directory:
+
+```
+make all
+```
+
+Fonts can be compiled individually as well:
+
+```
+make fonts/ttf/Xolonium-Regular.ttf
+```
+
+The generated files can be deleted with:
+
+```
+make clean
+```
+
+FontForge might complain about the AGLFN or non-BMP kern pairs,
+these are fixed during the build process.
+
+
+Dependencies
+------------
+
+### All
+
+- [FontForge](https://fontforge.github.io) 20200314
+- [FontTools](https://github.com/fonttools/fonttools) 4.17.0
+
+### TTF
+
+- [Humble Type Instruction Compiler](https://gitlab.com/sev/htic) 3.7
+
+### WOFF
+
+- [Zopfli Python wrapper](https://pypi.python.org/pypi/zopfli)
+- [Brotli Python wrapper](https://pypi.python.org/pypi/Brotli)
+
+
+Xonotic
+-------
+
+The Makefile also builds a GPL version of the fonts, for
+the game Xonotic. For this purpose, the metadata in the
+name table is adjusted. Everything else remains identical.