summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/actuarialsymbol/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/actuarialsymbol/README.md
Initial commit
Diffstat (limited to 'macros/latex/contrib/actuarialsymbol/README.md')
-rw-r--r--macros/latex/contrib/actuarialsymbol/README.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/macros/latex/contrib/actuarialsymbol/README.md b/macros/latex/contrib/actuarialsymbol/README.md
new file mode 100644
index 0000000000..eb496f24de
--- /dev/null
+++ b/macros/latex/contrib/actuarialsymbol/README.md
@@ -0,0 +1,56 @@
+# actuarialsymbol
+
+Package **actuarialsymbol** provides commands to compose
+actuarial symbols of life contingencies and financial mathematics
+characterized by subscripts and superscripts on both sides of a
+principal symbol. The package also features commands to easily and
+consistently position precedence numbers above or below statuses
+in symbols for multiple lives contracts.
+
+Since actuarial notation can get quite involved, the package defines a
+number of shortcut macros to ease entry of the most common elements.
+Appendix A of the package documentation lists the commands to typeset
+a large selection of symbols of life contingencies.
+
+## License
+
+LaTeX Project Public License, version 1.3c or (at your option) any
+later version.
+
+## Version
+
+1.1 (2019-06-13)
+
+## Authors
+
+David Beauchemin <david.beauchemin.5@ulaval.ca>, Vincent Goulet
+<vincent.goulet@act.ulaval.ca>
+
+## Dependency
+
+This package requires package **actuarialangle** (version v2.0 dated
+2017/04/10 or above is needed to typeset the documentation).
+
+## Installation
+
+The package is part of TeX Live and MiKTeX. If it is not already
+installed on your system, run `actuarialsymbol.dtx` through LaTeX with,
+for example,
+
+ pdflatex actuarialsymbol.dtx
+
+and copy `actuarialsymbol.sty` where LaTeX can find it.
+
+## Documentation
+
+File `actuarialsymbol.pdf` contains the complete documentation of the
+package. If needed, the documentation can be generated from the
+sources using the following commands:
+
+ pdflatex actuarialsymbol.dtx
+ makeindex -s gglo.ist -o actuarialsymbol.gls actuarialsymbol.glo
+ pdflatex actuarialsymbol.dtx
+
+## Version history
+
+See the documentation.