summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/tkz-doc/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/tkz-doc/README.md')
-rw-r--r--macros/latex/contrib/tkz-doc/README.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/macros/latex/contrib/tkz-doc/README.md b/macros/latex/contrib/tkz-doc/README.md
new file mode 100644
index 0000000000..ee48eb39b0
--- /dev/null
+++ b/macros/latex/contrib/tkz-doc/README.md
@@ -0,0 +1,39 @@
+# tkz-doc — Class and package for the documentation of all tkz-* packages.
+
+Release 1.42c 2020/03/20
+
+## Note
+
+This package is highly experimental and subject to change without notice.
+
+
+## Licence
+
+The scontents package may be modified and distributed under the terms and
+conditions of the [LaTeX Project Public License](https://www.latex-project.org/lppl/), version 1.3c or greater.
+
+## Installation
+
+The package `tkz-doc` is present in `TeXLive` and `MiKTeX`, use the
+package manager to install.
+
+For manual installation all files must be moved into the different directories in your
+installation `TDS` tree or in your `TEXMFHOME`:
+
+```
+ doc/README.md -> TDS:doc/latex/tkz-doc/README.md
+ latex/*.* -> TDS:tex/latex/tkz-doc/*.*
+```
+
+## How to use it
+
+1. If you want to compile the documentation of a `tkz-*` package, yuo need to use
+the lualatex engine.
+
+2. I added in the version 1.4, an option called `cadre`. If you want to draw the
+frame of the cover, you need to use this option. In this case, you need to
+install the font `orna4`. By default, no frame.
+
+## Author
+
+Alain Matthes, 5 rue de Valence, Paris 75005, al (dot) ma (at) mac (dot) com