summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/docshots/README.md
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2022-10-15 03:01:23 +0000
committerNorbert Preining <norbert@preining.info>2022-10-15 03:01:23 +0000
commit716f66d13d38e113c2d0491804fae5879de67bb3 (patch)
tree98e4752aa89041db35c60e5b893897e714561340 /macros/latex/contrib/docshots/README.md
parent1c0d5e0721918b8ee790c9f1c11f1543e0403322 (diff)
CTAN sync 202210150301
Diffstat (limited to 'macros/latex/contrib/docshots/README.md')
-rw-r--r--macros/latex/contrib/docshots/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/macros/latex/contrib/docshots/README.md b/macros/latex/contrib/docshots/README.md
new file mode 100644
index 0000000000..6201451a88
--- /dev/null
+++ b/macros/latex/contrib/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.