[latex3-commits] [git/LaTeX3-latex3-mathtools] master: Initial README (6e5e0ef)

[Joseph Wright]

Repository : https://github.com/latex3/mathtools
On branch  : master
Link       : https://github.com/latex3/mathtools/commit/6e5e0efe9d463e1bce772021a3738c169c90cc2b

>---------------------------------------------------------------

commit 6e5e0efe9d463e1bce772021a3738c169c90cc2b
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Wed Mar 4 16:05:46 2020 +0000

    Initial README
    
    Based heavily on the one from mhctan.


>---------------------------------------------------------------

6e5e0efe9d463e1bce772021a3738c169c90cc2b
 README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6d4b868
--- /dev/null
+++ b/README.md
@@ -0,0 +1,55 @@
+The `mathtools` bundle
+======================
+
+`mathtools`
+-----------
+
+The `mathtools` package provides many useful tools for mathematical
+typesetting. It is based on `amsmath` and fixes various deficiencies
+of `amsmath` and standard LaTeX. It provides:
+
+- Extensible symbols, such as brackets, arrows, harpoons, etc.
+- Various symbols such as `\coloneqq` (:=).
+- Easy creation of new tag forms.
+- Showing only the referenced equations.
+- Extensible arrows, harpoons and hook arrows.
+- Starred versions of the `amsmath` matrix environments for
+  specifying the column alignment.
+- More building blocks: multlined, cases-like environments, new
+  gathered environments.
+- Math versions of `\makebox`, `\llap`, `\rlap`, etc.
+- Cramped math styles.
+- and more ...
+
+`mathtools` requires `mhsetup`.
+
+`empheq`
+--------
+
+The `empheq` package is a visual markup extension designed to
+function on top of `amsmath`. It features:
+
+- Boxing multi line math displays while leaving equation
+  numbers untouched at the margin. Any kind of box will do.
+- Making the `ntheorem` package place end-of-theorem markers
+  perfectly.
+- Placing arbitrary material on either side of math displays.
+  This includes delimiters that automatically scale to the
+  correct size.
+
+`empheq` requires `mathtools`.
+
+`mhsetup`
+---------
+
+The `mhsetup` package defines various programming tools needed by
+both `empheq` and `mathtools`. In the future, most of these tools will
+probably be an integral part of LaTeX3.
+
+-----
+
+<p>Copyright (C) 2002-2011 Morten Hoegholm <br />
+Copyright (C) 2012-2019 Lars Madsen <br />
+Copyright (C) 2020 Lars Madsen, The LaTeX3 Project <br />
+<a href="https://latex-project.org/">https://latex-project.org/</a> <br />
+All rights reserved.</p>