summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/docshots/README.md
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2022-10-15 20:25:06 +0000
committerKarl Berry <karl@freefriends.org>2022-10-15 20:25:06 +0000
commitec281bf8032a69f84b4b584c76158dc2c6ecdb57 (patch)
tree98c0d66a83e8f15a5f3384d7e6a471ab2ccbfc6a /Master/texmf-dist/doc/latex/docshots/README.md
parent3f6f2deec08918d9165fe4c72bcf4b8380c299c6 (diff)
docshots (14oct22)
git-svn-id: svn://tug.org/texlive/trunk@64716 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/docshots/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/docshots/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/docshots/README.md b/Master/texmf-dist/doc/latex/docshots/README.md
new file mode 100644
index 00000000000..6201451a88e
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/docshots/README.md
@@ -0,0 +1,25 @@
+[![l3build](https://github.com/yegor256/docshots/actions/workflows/l3build.yml/badge.svg)](https://github.com/yegor256/docshots/actions/workflows/l3build.yml)
+[![CTAN](https://img.shields.io/ctan/v/docshots)](https://ctan.org/pkg/docshots)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/docshots/blob/master/LICENSE.txt)
+
+This LaTeX package helps you add PDF snapshots to DTX documentation.
+
+First, [install it](https://en.wikibooks.org/wiki/LaTeX/Installing_Extra_Packages)
+from [CTAN](https://ctan.org/pkg/docshots)
+and then use in DTX:
+
+```tex
+% \begin{docshot}
+% \documentclass{article}
+% \pagestyle{empty}
+% \begin{document}
+% Hello, \LaTeX!
+% \end{document}
+% \end{docshot}
+```
+
+If you want to contribute yourself, make a fork, then create a branch,
+then run `l3build ctan` in the root directory.
+It should compile everything without errors. If not, submit an issue and wait.
+Otherwise, make your changes and then run `l3build ctan` again. If the build is
+still clean, submit a pull request.