summaryrefslogtreecommitdiff
path: root/graphics/pgf/contrib/jigsaw/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'graphics/pgf/contrib/jigsaw/README.md')
-rw-r--r--graphics/pgf/contrib/jigsaw/README.md29
1 files changed, 26 insertions, 3 deletions
diff --git a/graphics/pgf/contrib/jigsaw/README.md b/graphics/pgf/contrib/jigsaw/README.md
index 85fd24c58a..9ec853f080 100644
--- a/graphics/pgf/contrib/jigsaw/README.md
+++ b/graphics/pgf/contrib/jigsaw/README.md
@@ -1,9 +1,32 @@
+![](https://raw.githubusercontent.com/samcarter/jigsaw/main/ICON.png)
+
+
# Jigsaw
+[![GitHub](https://img.shields.io/github/license/samcarter/jigsaw.svg?color=blue)](http://www.latex-project.org/lppl.txt)
+[![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/samcarter/jigsaw.svg?label=current%20version)](https://github.com/samcarter/jigsaw/releases/latest)
+[![CTAN](https://img.shields.io/ctan/v/jigsaw.svg)](https://ctan.org/pkg/jigsaw)
+
+
A small LaTeX package to draw jigsaw pieces with TikZ. It is possible to draw individual pieces and adjust their shape, produce tile patterns or to automatically generate complete jigsaws.
-Current version: 2023/02/21 version v0.4
+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/jigsaw .
+
+### Usage
+
+```latex
+\documentclass{standalone}
+\usepackage{jigsaw}
+
+\begin{document}
+
+\begin{tikzpicture}
+ \piece[color=teal]{1}{-1}{1}{-1}
+\end{tikzpicture}
-This project is licensed under the LaTeX Project Public License v1.3c or later, see http://www.latex-project.org/lppl.txt
+\end{document}
+```
-The project repository, including a bug tracker, can be found at https://github.com/samcarter/jigsaw/issues
+For more details, please consult the [package documentation](https://github.com/samcarter/jigsaw/blob/main/DOCUMENTATION.pdf).