summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/currency/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/currency/README.md
Initial commit
Diffstat (limited to 'macros/latex/contrib/currency/README.md')
-rw-r--r--macros/latex/contrib/currency/README.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/macros/latex/contrib/currency/README.md b/macros/latex/contrib/currency/README.md
new file mode 100644
index 0000000000..f95dbead14
--- /dev/null
+++ b/macros/latex/contrib/currency/README.md
@@ -0,0 +1,56 @@
+# currency — Formatting currencies
+
+
+## Overview
+
+`currency` is a LaTeX package that facilitates the formatting
+of currencies (amounts and units). It is based on the `siunitx` package
+for printing numbers.
+
+For instance, this code in the preamble defines a EUR monetary unit
+
+``` latex
+\DefineCurrency{EUR}{name={euro},plural={euros},symbol={\euro},iso={EUR},kind=iso,base=2}
+```
+
+that will be used later by
+
+``` latex
+\dEUR{123} or \dEUR[kind=plural]{123}
+```
+to print `123 EUR or 123 euros`. There are many ways to change to output
+(the symbol could be put in front of the amount as required by some
+typographical conventions, ...).
+
+
+See the [documentation](https://github.com/antoinelejay/currency/blob/master/currency_doc.pdf)
+for examples and installation instructions.
+
+## License
+
+This work may be distributed and/or modified under the conditions of the
+[LaTeX Project Public License](http://www.latex-project.org/lppl.txt) (LPPL),
+version 1.3 or later.
+
+Please use the project's GitHub site at <https://github.com/antoinelejay/currency>
+for suggestions, feature requests, and bug reports.
+
+## Installation
+
+```
+pdflatex currency.ins
+pdflatex currency.dtx
+makeindex -s gind.ist currency.idx
+makeindex -s gglo.ist -o currency.gls currency.glo
+pdflatex currency.dtx
+
+pdflatex currency_doc.tex
+biber currency_doc
+pdflatex currency_doc.tex
+```
+
+## Availability
+
+This package is available on [github](https://github.com/antoinelejay/currency) and on
+[CTAN](http://www.ctan.org/tex-archive/macros/latex/contrib/currency)
+