Debian Codegraph @

texmf-dist/doc/latex/unicode-math/README.md

raw
1 The UNICODE-MATH package
2 ========================
3
4 This package provides an implementation of Unicode/OpenType mathematics for
5 XeLaTeX and LuaLaTeX.
6
7 While I am a little wary of encouraging people to use this package for
8 production work, I understand that it has certain uses and am making it
9 available for distribution. Your testing and feedback is essential to fill
10 in the many gaps that I miss!
11
12 Please be aware that this package is undergoing continued development and the
13 interface and functionality should not be considered completely stable. But
14 the more the package is used the more stable it will become. (Things are
15 generally working now; it is only minutiae that may change in the future.)
16
17 Unicode maths is currently supported by the following freely available fonts:
18
19 - [Latin Modern Math][LM] (Bogusław Jackowski, Janusz M. Nowacki)
20 - [TeX Gyre Bonum Math][BM] (B. Jackowski, P. Strzel­czyk and P. Pianowski)
21 - [TeX Gyre Pagella Math][PM] (B. Jackowski, P. Strzelczyk and P. Pianowski)
22 - [TeX Gyre Schola Math][SCM] (B. Jackowski, P. Strzelczyk and P. Pianowski)
23 - [TeX Gyre Termes Math][TM] (B. Jackowski, P. Strzelczyk and P. Pianowski)
24 - [DejaVu Math TeX Gyre][DEJA] (B. Jackowski, P. Strzelczyk and P. Pianowski)
25 - [Asana Math][AM] (Apostolos Syropolous),
26 - [STIX][STIX] (STIpub), and
27 - [XITS Math][XM] (Khaled Hosny),
28 - [Libertinus Math][LIB] (Philipp H. Poll and Khaled Hosny).
29 - [Fira Math][FIRA] (Xiangdong Zeng).
30
31 These fonts are available under open source licences
32 (the [GUST Font License][GFL] and [Open Font Licence][OFL]).
33
34 The following fonts are proprietary with OpenType maths support:
35
36 - [Lucida Bright Math][LUCI] (Charles Bigelow and Kris Holmes)
37 - [Cambria Math][CM] (Microsoft),
38 - [Minion Math][MM] (Johannes Küster, typoma GmbH)
39
40 I'm always looking for new fonts to test with, so please let me know of any
41 new releases.
42
43 [CM]: http://www.ascenderfonts.com/font/cambria-regular.aspx
44 [LUCI]: http://tug.org/store/lucida/opentype.html
45 [MM]: http://www.typoma.com/en/fonts.html
46 [LM]: http://www.gust.org.pl/projects/e-foundry/lm-math
47 [PM]: http://www.ctan.org/pkg/tex-gyre-math-pagella
48 [BM]: http://www.ctan.org/pkg/tex-gyre-math-bonum
49 [SCM]: http://www.ctan.org/pkg/tex-gyre-math-schola
50 [TM]: http://www.ctan.org/pkg/tex-gyre-math-termes
51 [DEJA]: https://ctan.org/pkg/tex-gyre-math-dejavu
52 [AM]: http://www.ctan.org/pkg/asana-math
53 [STIX]: http://www.stixfonts.org
54 [XM]: http://github.com/khaledhosny/xits-math
55 [LIB]: https://ctan.org/pkg/libertinus
56 [GFL]: http://www.gust.org.pl/projects/projects/e-foundry/licenses/
57 [OFL]: http://scripts.sil.org/OFL
58 [FIRA]: https://github.com/firamath/firamath
59
60
61 PACKAGE USAGE
62 -------------
63
64 Please see the PDF documentation for full details. A simple beginning is:
65
66 ```tex
67 \usepackage{unicode-math}
68 \setmathfont{texgyrepagella-math.otf}
69 ```
70
71 Most LaTeX math should still work after this. (Let me know if it doesn't.)
72 Furthermore, it will be in a different font.
73
74
75 REQUIREMENTS
76 ------------
77
78 As well as running XeTeX or LuaTeX, this package requires recent versions of the
79 `lm-math`, `fontspec`, `expl3`, `xpackages`, and `lualatex-math` packages.
80
81
82 THANKS
83 ------
84
85 I write LaTeX code as a hobby and a passion, not as part of my day job.
86 If you would like to say thanks, please consider a donation at: <https://www.patreon.com/wspr>
87
88
89 DEVELOPMENT and MAINTENANCE
90 ---------------------------
91
92 The current release version is available from CTAN:
93 > <https://ctan.org/pkg/unicode-math>
94
95 Latest developmental and archived historical versions are available from Github:
96 > <http://github.com/wspr/unicode-math>
97
98 Please file bug reports with minimal examples:
99 > <http://github.com/wspr/unicode-math/issues>
100
101 See `CHANGES.md` for the complete listing of change history.
102
103 Further information on the details surrounding the development of the package
104 can be found in the `CONTRIBUTING.md` file in the Github repository.
105
106
107 LICENCE
108 -------
109
110 The unicode-math package may be modified and distributed under the terms and
111 conditions of the [LaTeX Project Public License][LPPL], version 1.3c or
112 greater.
113
114 [LPPL]: http://www.latex-project.org/lppl/
115
116 This work is maintained by Will Robertson and consists of the files listed in `MANIFEST.md`.