Update ignore list for new source file patterns.
[fontstandard.git] / README.md
1 # Font Standard
2
3 Font Standard is a suite of pictographic icons for easily scalable
4 vector graphics on websites. Those icons are assigned, when possible,
5 to a proper public Unicode codepoint, and do not include
6 questionably-licensed corporate logos, Libertarian tulips, or some
7 bullshit web service you'll forget about in less than a year.
8
9 Font Standard is based on [Font Awesome][], which does not live up to
10 its name. It is about 40% smaller than Font Awesome (even smaller if
11 you no longer use FA's custom CSS), and usable in more situations.
12
13 ## Building
14
15 Install [FontForge][], then at a command line, run
16
17 make all
18
19 Now you'll get `fontstandard.ttf` and `fontstandard.woff`. These can
20 be used as drop-in replacements for Font Awesome, or independently as
21 a font with many useful Unicode glyphs.
22
23 ## Compatibility
24
25 Font Standard is compatible with Font Awesome, as long as you are not
26 using any [Brand Icons][] or its awful gender icons. (If you are using
27 any of these, reconsider the life choices that brought you to do so.)
28
29 Font Standard is _also_ compatible with regular HTML, and
30 you can just assign a CSS font family and type Unicode characters like
31 ♫ or ☕ and they will render appropriately.
32
33 Font Standard mappings may change in future updates. For example, the
34 Font Awesome "bolt" icon (U+F0E7) is mapped to U+2301 (Electric
35 Arrow), U+26a1 (High Voltage Sign), and 1+F5F2 (Lightning Mood). If a
36 more "arrow-like" or "sign-like" bolt appears in Font Awesome in the
37 future, it might take over those slots.
38
39 ## Known Issues
40
41 Some characters may be mis-mapped. Some characters are probably
42 suitable for mapping but are not yet. Let me know if you have
43 suggestions.
44
45 ## License
46
47 The scripts that build Font Standard are hereby deeded to the
48 [public domain][]. The person who associated a work with this deed has
49 dedicated the work to the public domain by waiving all of his or her
50 rights to the work worldwide under copyright law, including all
51 related and neighboring rights, to the extent allowed by law. You can
52 copy, modify, distribute and perform the work, even for commercial
53 purposes, all without asking permission.
54
55 No claim is made on the "Font Standard" name.
56
57 [Font Awesome][] by Dave Gandy is licensed under the [SIL OFL 1.1][] with
58 the reserved name "FontAwesome".
59
60 [Font Awesome]: http://fontawesome.io/
61 [FontForge]: http://fontforge.org/
62 [Brand Icons]: http://fortawesome.github.io/Font-Awesome/icons/#brand
63 [SIL OFL 1.1]: http://scripts.sil.org/OFL
64 [public domain]: https://creativecommons.org/publicdomain/zero/1.0/