summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/tikzmarmots/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/tikzmarmots/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/tikzmarmots/README.md30
1 files changed, 24 insertions, 6 deletions
diff --git a/Master/texmf-dist/doc/latex/tikzmarmots/README.md b/Master/texmf-dist/doc/latex/tikzmarmots/README.md
index 5dbde87676b..f9c865db22a 100644
--- a/Master/texmf-dist/doc/latex/tikzmarmots/README.md
+++ b/Master/texmf-dist/doc/latex/tikzmarmots/README.md
@@ -1,14 +1,32 @@
-# Tikzmarmots
+![](https://raw.githubusercontent.com/samcarter/tikzmarmots/main/ICON.png)
+
+# TikZmarmots
+
+[![GitHub](https://img.shields.io/github/license/samcarter/tikzmarmots.svg?color=blue)](http://www.latex-project.org/lppl.txt)
+[![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/samcarter/tikzmarmots.svg?label=current%20version)](https://github.com/samcarter/tikzmarmots/releases/latest)
+[![CTAN](https://img.shields.io/ctan/v/tikzmarmots.svg)](https://ctan.org/pkg/tikzmarmots)
+
+This is a little LaTeX package to draw marmots with TikZ.
> *Notice: this package has been merged into the TikZlings package and, starting with version 2.0, is now a wrapper around the `tikzlings-marmots` package. The previous version can be accessed via `\usepackage{tikzmarmots}[v1]`.*
-This is a little LaTeX package for marmots to be used in TikZ pictures.
+This project is licensed under the LaTeX Project Public License v1.3c or later, see http://www.latex-project.org/lppl.txt .
+
+The project repository, including a bug tracker, can be found at https://github.com/samcarter/tikzmarmots .
+
+### Usage
-This project is licensed under the LaTeX Project Public License v1.3c or later, see http://www.latex-project.org/lppl.txt
+```latex
+\documentclass{standalone}
+\usepackage{tikzmarmots}
-The project repository, including a bug tracker, can be found at https://github.com/samcarter/tikzmarmots/issues
+\begin{document}
+\begin{tikzpicture}
+ \marmot
+\end{tikzpicture}
-### A few examples:
+\end{document}
+```
-![tikz marmots](https://user-images.githubusercontent.com/8226363/42419778-ba1cf506-82bb-11e8-8e44-15f9837188e4.png)
+For more details, please consult the [package documentation](https://github.com/samcarter/tikzmarmots/blob/main/DOCUMENTATION.pdf).