summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/tkz/tkz-elements/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/tkz/tkz-elements/README.md')
-rw-r--r--macros/latex/contrib/tkz/tkz-elements/README.md73
1 files changed, 73 insertions, 0 deletions
diff --git a/macros/latex/contrib/tkz/tkz-elements/README.md b/macros/latex/contrib/tkz/tkz-elements/README.md
new file mode 100644
index 0000000000..49f16ad785
--- /dev/null
+++ b/macros/latex/contrib/tkz/tkz-elements/README.md
@@ -0,0 +1,73 @@
+# tkz-elements — for euclidean geometry
+
+Release 1.00b 2023/10/25
+
+## Description
+
+`tkz-elements` is the first version of a library written in lua, allowing to make all the necessary calculations to define the objects of a Euclidean geometry figure. You need to compile with `LuaLaTeX`. With `tkz-elements`, the definitions and calculations are only done with `Lua`.
+
+ The main possibility of programmation proposed is oriented "object programming" with object classes like point, line, triangle, circle and ellipse. For the moment, once the calculations are done, it is `tkz-euclide` or `TikZ` which allows the drawings.
+
+## Licence
+
+This 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.3 or greater.
+
+
+## Requirements
+
+The package compiles with utf8 and lualatex. You need actually to load:
+
+- [tikz](https://ctan.org/pkg/tikz)
+- [tkz-euclide](https://ctan.org/pkg/tkz-euclide)
+
+## Installation
+
+The package `tkz-elements` is (will be) present in TeXLive and MiKTeX, use the package
+manager to install.
+
+You can experiment with the `tkz-elements` package by placing all of the
+distribution files in the directory containing your current tex file.
+
+The different files must be moved into the different directories in your
+installation `TDS` tree or in your `TEXMFHOME`:
+
+
+## How to use it
+
+To use the package `tkz-elements`, place the following lines in the preamble of
+your LaTeX document:
+
+```
+\usepackage{tkz-elements}
+\begin{document}
+\begin{tkzelements}
+ your code
+\end{tkzelements}
+\begin{tikzpicture}
+ your code
+\end{tikzpicture}
+```
+
+If you use the `xcolor` package, load that package before `tkz-euclide` to avoid
+package conflicts.
+
+## Documentation
+
+Documentation for `tkz-euclide` is available on `CTAN`.
+
+## Examples
+
+All examples given in documentation will be stored on my site : [http://altermundus.fr](http://altermundus.fr) as standalone
+files, ready for compilation.
+
+Other examples, in French, are on my site.
+
+
+## History
+
+- First version 1.00b
+
+## Author
+
+Alain Matthes, 5 rue de Valence, Paris 75005, al (dot) ma (at) mac (dot) com