summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/breqn/README.md
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/breqn/README.md
Initial commit
Diffstat (limited to 'macros/latex/contrib/breqn/README.md')
-rw-r--r--macros/latex/contrib/breqn/README.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/macros/latex/contrib/breqn/README.md b/macros/latex/contrib/breqn/README.md
new file mode 100644
index 0000000000..ab25e9bf71
--- /dev/null
+++ b/macros/latex/contrib/breqn/README.md
@@ -0,0 +1,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.
+
+