summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/breqn/README.md
blob: ab25e9bf71dd3e8c41bac3cf0bc510c2a7763ceb (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

# The BREQN packages

This is the latest repository for the breqn package, originally developed by
Michael J. Downes and later taken over by Morten Høgholm.
Will Robertson currently manages the code but without time for major development.

* CTAN URL: <https://ctan.org/pkg/breqn>
* Feedback/bugs: <https://github.com/wspr/breqn/issues>
* Change history: [CHANGES.md](./CHANGES.md)

## Installation

The `breqn` packages are distributed in the major TeX distributions so manual installation
is only necessary if you wish to install pre-release versions or contribute to the development
of the package.

Individually, running `pdftex` on each dtx file extracts the runtime files.
As a package, `l3build install` will extract the needed files and install them locally.



# The code

## breqn

The breqn package facilitates automatic line-breaking of displayed
math expressions.

## flexisym

This package turns math symbols into macros.
It is required by breqn so that breqn can make intelligent decisions
with respect to line-breaking and other details.

## mathstyle

Ensures uniform syntax for math subscript (_) and superscript (^)
operations so that they always take exactly one argument.
Grants access to the current mathstyle which eases several tasks such
as avoiding the many pitfalls of \mathchoice and \mathpalette.
This package is used by flexisym.