summaryrefslogtreecommitdiff
path: root/macros/luatex/latex/lualatex-math/README
blob: 9224b9bcb3d365a3028bd8e6ad1e8ccf4e40f90f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
The ``lualatex-math`` package
=============================

This package patches a few commands of the LaTeX 2ε kernel and the ``amsmath``,
``amsopn``, ``mathtools`` and ``icomma`` packages to be more compatible with
the LuaTeX engine.  It is only meaningful if you compile your documents with
LuaLaTeX.


License
-------

This material is subject to the LaTeX Project Public License, either
version 1.3c of this license or (at your option) any later version.  See
http://www.latex-project.org/lppl/ for the details of that license.


Installation
------------

Copy the files ``lualatex-math.sty`` and ``lualatex-math.lua`` to a place where
TeX can find them.  The documentation is contained in the file
``lualatex-math.pdf``.

To produce the runtime files from the Docstrip source, run ``make``.  To
produce the PDF manual, run ``make pdf``.  To produce and compile a few test
files, run ``make check``.  To compile the manual you’ll need my `custom
documentation class`_.

To install the runtime files in your home TEXMF tree, run ``make install``.  To
install the PDF manual in your home TEXMF tree, run ``make install-pdf``.  The
package includes an AucTeX style file which will be installed in
``~/.emacs.d``.

.. _custom documentation class: https://github.com/phst/phst-doc


Usage
-----

Include the package via ``\usepackage{lualatex-math}``.  The package has no
options and no public interface; it applies the appropriate fixes
automatically.  See ``lualatex-math.pdf`` for details.

If you encounter any issues, please report them by means of the `issue
tracker`_.

.. _issue tracker: https://github.com/phst/lualatex-math/issues