move usage to readme

zblz · zblz · commit c0dbdd2206b3 · 2015-12-03T19:41:42.000Z
diff --git a/tools/README_subset.md b/tools/README_subset.md
@@ -0,0 +1,15 @@
+Subsetting DejaVu fonts to create a display-math-only font
+----------------------------------------------------------
+
+The DejaVu fonts include math display variants outside of the unicode range, and
+it is currently hard to access them from matploltib. The subset.py script in
+`tools` has been modified to move the math display variants found in DejaVu
+fonts into a new TTF font with these variants in the unicode range.
+
+To use it, you need to install the fontforge python bindings. The DejaVu fonts
+are in the lib/matplotlib/mpl-data/fonts/ttf directory in the matplotlib tree.
+From that directory, run the subset.py script as follows to generate the new
+font files `DejaVuSansDisplay.ttf` and `DejaVuSerifDisplay.ttf`:
+
+    $ python ../../../../../tools/subset.py --move-display --subset=dejavu-ext DejaVuSans.ttf DejaVuSansDisplay.ttf
+    $ python ../../../../../tools/subset.py --move-display --subset=dejavu-ext DejaVuSerif.ttf DejaVuSerifDisplay.ttf
diff --git a/tools/subset.py b/tools/subset.py
@@ -377,17 +377,4 @@ def main(argv):
     subset_font(font_in, font_out, subset, opts)
 
 if __name__ == '__main__':
-    if len(sys.argv[1:]) == 0 or sys.argv[1] == '-h':
-        print('''A script for subsetting a TTF font.
-
-This version has been modified to move the math display variants found in DejaVu
-fonts into a new TTF font with these variants in the unicode range. In the
-matplotlib tree, these fonts are in lib/matplotlib/mpl-data/fonts/ttf. To
-generate these fonts, move into this directory, and run:
-
-$ python ../../../../../tools/subset.py --move-display --subset=dejavu-ext DejaVuSans.ttf DejaVuSansDisplay.ttf
-$ python ../../../../../tools/subset.py --move-display --subset=dejavu-ext DejaVuSerif.ttf DejaVuSerifDisplay.ttf
-                ''')
-        sys.exit(1)
-
     main(sys.argv[1:])
