summaryrefslogtreecommitdiff
path: root/macros/generic/witharrows/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/generic/witharrows/README.md
Initial commit
Diffstat (limited to 'macros/generic/witharrows/README.md')
-rw-r--r--macros/generic/witharrows/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/macros/generic/witharrows/README.md b/macros/generic/witharrows/README.md
new file mode 100644
index 0000000000..fa5444c5e1
--- /dev/null
+++ b/macros/generic/witharrows/README.md
@@ -0,0 +1,32 @@
+# Readme for the package witharrows
+
+Author : F. Pantigny (`fpantigny@wanadoo.fr`).
+
+CTAN page : `https://ctan.org/pkg/witharrows`
+
+## License
+The extension `witharrows` for TeX and LaTeX is distributed under the LPPL 1.3 license.
+
+## Presentation
+
+The LaTeX package `witharrows` provides environments `{WithArrows}` and `{DispWithArrows}`
+similar to the environments `{aligned}` and `{align}` of `amsmath` but with the possibility to draw arrows on the right side of the alignment. These arrows are usually used to give explanations concerning the mathematical calculus presented.
+
+The extension `witharrows` can also be used with plain-TeX.
+
+
+
+## Installation
+
+The package `witharrows` is present in the distributions MiKTeX, TeXLive and MacTeX.
+
+For a manual installation:
+
+* put the files `witharrows.ins` dans `witharrows.dtx` in the same directory;
+* run `latex witharrows.ins`.
+
+The files `witharrows.sty` and `witharrows.tex` will be generated.
+
+The file `witharrows.sty` is the only file necessary to use the extension `witharrows` with LaTeX (with `\usepakage{witharrows}`).
+
+The file `witharrows.tex` is the only file necessary to use the extension `witharrows` with plain-TeX (with `\input{witharrows.tex}`).