summaryrefslogtreecommitdiff
path: root/graphics/pgf/contrib/puyotikz/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'graphics/pgf/contrib/puyotikz/README.md')
-rw-r--r--graphics/pgf/contrib/puyotikz/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/graphics/pgf/contrib/puyotikz/README.md b/graphics/pgf/contrib/puyotikz/README.md
new file mode 100644
index 0000000000..70097df553
--- /dev/null
+++ b/graphics/pgf/contrib/puyotikz/README.md
@@ -0,0 +1,21 @@
+# PuyoTikZ
+
+A LaTeX package for quickly typesetting board states of Puyo Puyo games.
+
+Supports large and small boards with arbitrary shape, hidden rows, current and next puyos, labels and move planning markers. Source code available for download on [GitHub](https://github.com/amosborne/puyotikz) or your favorite TeX repository. Package requires [Python3](https://www.python.org/) in support of scripts driven by [PythonTeX](https://github.com/gpoore/pythontex).
+
+Please see the PuyoTikZ documentation for more details on usage, installation, and known limitations.
+
+Created by [terramyst](https://twitter.com/terramyst1).
+
+MIT License.
+
+```tex
+% Example usage.
+\begin{puyotikz}[\puyosmallscale]
+ \puyoboard{rg/rgr/br/g}{rr/rb/gg}
+ \puyomarker{e1rA/e2rA/f1bB/f2rB}
+\end{puyotikz}
+
+\puyogrid[nrows=4, ncols=4]{bbb/rrrb/gggr/yyyg}
+```