summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/tikzpeople/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/tikzpeople/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/tikzpeople/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/tikzpeople/README.md b/Master/texmf-dist/doc/latex/tikzpeople/README.md
new file mode 100644
index 00000000000..aff8e5cd50e
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/tikzpeople/README.md
@@ -0,0 +1,24 @@
+The tikzpeople package provides people shaped nodes to be used in tikz.
+The available node shapes are:
+
+ alice, bob, bride, builder, businessman, charlie, chef, conductor, cowboy,
+ criminal, dave, graduate, groom, guard, jester, judge, mexican, nun, nurse,
+ physician, pilot, police, priest, sailor, santa, surgeon
+
+The package has three options:
+ - The "draft" option causes all tikzpeople to be rendered as a basic outline
+ of a person.
+ - The "demo" option adds two commands.
+ The command \alltikzpeople{<width>}{<options>} produces a series of figures
+ of all available shapes with the given width and the provided options
+ applied. The command \tikzpeoplecolors{<shapename>} produces a figure
+ showing the available color keys for the shape.
+ - The "nonbeards" option removes all beards.
+
+The nodes have the following hopefully self explanatory options:
+ evil, good, female, mirrored, monitor
+All options can be combined freely.
+
+The tikzpeople package is licensed under the LaTeX Project Public License
+
+ -- Nils Fleischhacker <mail@nilsfleischhacker.de> 08 Nov 2016