summaryrefslogtreecommitdiff
path: root/graphics/pgf/contrib/tikz-lake-fig/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'graphics/pgf/contrib/tikz-lake-fig/README.md')
-rw-r--r--graphics/pgf/contrib/tikz-lake-fig/README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/graphics/pgf/contrib/tikz-lake-fig/README.md b/graphics/pgf/contrib/tikz-lake-fig/README.md
new file mode 100644
index 0000000000..5d64135249
--- /dev/null
+++ b/graphics/pgf/contrib/tikz-lake-fig/README.md
@@ -0,0 +1,40 @@
+# tikz-lake-fig
+
+[![GitHub](https://img.shields.io/github/license/jsta/tikz-lake-fig.svg?color=blue)](http://www.latex-project.org/lppl.txt)
+[![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/jsta/tikz-lake-fig.svg?label=current%20version)](https://github.com/jsta/tikz-lake-fig/releases/latest)
+[![CTAN](https://img.shields.io/ctan/v/tikz-lake-fig.svg)](https://ctan.org/pkg/tikz-lake-fig)
+
+A collection of schematic diagrams of lakes for use in LaTeX documents. Diagrams include representations of material budgets, fluxes, and connectivity arrangements.
+
+## Usage
+
+Call diagram commands in your document by setting `tikz-lake-fig.sty` as an input (e.g. `\usepackage{tikz-lake-fig}`). Each command takes a single argument specifiying the scale of the diagram (optionally a second argument for fill color):
+
+```latex
+\documentclass{standalone}
+\usepackage{tikz-lake-fig}
+
+\begin{document}
+
+\secondarywireframe[1]
+
+\end{document}
+```
+
+![tikz lakes](example.png)
+
+## Prerequsites
+
+### LaTeX packages
+
+| import | pbox | relsize |
+| --------------- | ------------ | ------- |
+| __pgfplots__ | __subfiles__ | |
+
+## Gallery
+
+See [tikz-lake-fig-doc.pdf](https://github.com/jsta/tikz-lake-fig/blob/master/tikz-lake-fig-doc.pdf)
+
+## Links
+
+This collection inspired by [JLDiaz](https://tex.stackexchange.com/questions/95044/create-diagrams-in-latex-with-tikz)