summaryrefslogtreecommitdiff
path: root/graphics/pgf/contrib/tikz-timing/README
diff options
context:
space:
mode:
Diffstat (limited to 'graphics/pgf/contrib/tikz-timing/README')
-rw-r--r--graphics/pgf/contrib/tikz-timing/README57
1 files changed, 57 insertions, 0 deletions
diff --git a/graphics/pgf/contrib/tikz-timing/README b/graphics/pgf/contrib/tikz-timing/README
new file mode 100644
index 0000000000..d5546fa384
--- /dev/null
+++ b/graphics/pgf/contrib/tikz-timing/README
@@ -0,0 +1,57 @@
+--------------------------------------------------------------
+ tikz-timing
+--------------------------------------------------------------
+
+This package provides macros and an environment to generate timing diagrams
+(digital waveforms) without much effort. The TikZ (pgf) package is used to
+produce the graphics. The diagrams may be inserted into text (paragraphs,
+\hbox, etc.) and into tikzpictures. A tabular-like environment is provided to
+produce larger timing diagrams.
+
+Copyright (C) 2009-2017 Martin Scharrer
+E-mail: martin@scharrer-online.de
+WWW: http://latex.scharrer-online.de/tikz-timing/
+
+This work may be distributed and/or modified under the
+conditions of the LaTeX Project Public License, either version 1.3c
+of this license or (at your option) any later version.
+The latest version of this license is in
+ http://www.latex-project.org/lppl.txt
+and version 1.3c or later is part of all distributions of LaTeX
+version 2008/05/04 or later.
+
+This work has the LPPL maintenance status `maintained'.
+
+The Current Maintainer of this work is Martin Scharrer.
+
+This work consists of the files tikz-timing.dtx, tikz-timing.ins
+and the derived file tikz-timing.sty.
+
+
+Tiny example:
+~~~~~~~~~~~~~
+In text:
+ \texttiming{HLHLHLHLHLHL}
+Inside tikzpicture:
+ \timing [settings] (1,2) {HLHLHLHLHL};
+
+
+INSTALL:
+~~~~~~~~
+From the .dtx file (if you don't get the .sty files directly):
+==================
+Unpack the zip file and run:
+ [pdf]latex tikz-timing.ins
+Place the tikz-timing.sty file into your TEXMF tree, e.g. in
+ $TEXMF/tex/latex/tikz-timing
+
+DOCUMENTATION:
+~~~~~~~~~~~~~~
+To create the documentation:
+
+ [pdf]latex tikz-timing.dtx
+ makeindex -s gind.ist -o tikz-timing.ind tikz-timing.idx
+ makeindex -s gglo.ist -o tikz-timing.gls tikz-timing.glo
+ [pdf]latex tikz-timing.dtx
+ [pdf]latex tikz-timing.dtx
+