diff options
Diffstat (limited to 'graphics/pgf/contrib/tikzbricks/README.md')
-rw-r--r-- | graphics/pgf/contrib/tikzbricks/README.md | 27 |
1 files changed, 23 insertions, 4 deletions
diff --git a/graphics/pgf/contrib/tikzbricks/README.md b/graphics/pgf/contrib/tikzbricks/README.md index 8cd336a7c3..57dd862009 100644 --- a/graphics/pgf/contrib/tikzbricks/README.md +++ b/graphics/pgf/contrib/tikzbricks/README.md @@ -1,11 +1,30 @@ +![](https://raw.githubusercontent.com/samcarter/tikzbricks/main/ICON.png) + # TikZbricks +[![GitHub](https://img.shields.io/github/license/samcarter/tikzbricks.svg?color=blue)](http://www.latex-project.org/lppl.txt) +[![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/samcarter/tikzbricks.svg?label=current%20version)](https://github.com/samcarter/tikzbricks/releases/latest) +[![CTAN](https://img.shields.io/ctan/v/tikzbricks.svg)](https://ctan.org/pkg/tikzbricks) + A small LaTeX package to draw bricks with TikZ. The user can modify the colour, shape and viewpoint. -Current version: 2022/07/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/tikzbricks . + +### Usage + +```latex +\documentclass{standalone} +\usepackage{tikzbricks} + +\begin{document} -![example image of three bricks](https://raw.githubusercontent.com/samcarter/TikZbricks/main/showcase/showcase.svg) +\begin{tikzpicture} + \brick[color=blue]{4}{2} +\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/TikZbricks/issues +For more details, please consult the [package documentation](https://github.com/samcarter/tikzbricks/blob/main/DOCUMENTATION.pdf). |