summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/iexec/README.md
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2021-07-09 19:59:07 +0000
committerKarl Berry <karl@freefriends.org>2021-07-09 19:59:07 +0000
commitb0f009a4165cc5ec9f8740cfce773123c6bec62f (patch)
tree18d5735404ec2436f31148af0ce198e298dd3e52 /Master/texmf-dist/doc/latex/iexec/README.md
parent4e2ff022addfdb8e2ee9be9b8752a9a19cc92155 (diff)
iexec (9jul21)
git-svn-id: svn://tug.org/texlive/trunk@59884 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/iexec/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/iexec/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/iexec/README.md b/Master/texmf-dist/doc/latex/iexec/README.md
new file mode 100644
index 00000000000..2025d21ebd0
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/iexec/README.md
@@ -0,0 +1,26 @@
+[![make](https://github.com/yegor256/iexec/actions/workflows/latexmk.yml/badge.svg)](https://github.com/yegor256/iexec/actions/workflows/latexmk.yml)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/iexec/blob/master/LICENSE.txt)
+
+This LaTeX package helps you execute commands from the document and then input
+their output. The package uses [`ShellEscape`](https://ctan.org/pkg/ShellEscape) package.
+
+First, [install it](https://en.wikibooks.org/wiki/LaTeX/Installing_Extra_Packages)
+from [CTAN](https://ctan.org/pkg/iexec)
+and then use in the preamble:
+
+```tex
+\documentclass{article}
+\usepackage{iexec}
+\begin{document}
+Today is \iexec{date +\%e-\%b-\%Y}.
+\end{document}
+```
+
+The full example and all commands are available in the
+[`iexec.tex`](https://github.com/yegor256/exec/blob/master/iexec.tex) file.
+
+If you want to contribute yourself, make a fork, then create a branch,
+then run `make` in the root directory.
+It should compile everything without errors. If not, submit an issue and wait.
+Otherwise, make your changes and then run `make` again. If the build is
+still clean, submit a pull request.