summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/binarytree/README
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2016-07-30 23:12:58 +0000
committerKarl Berry <karl@freefriends.org>2016-07-30 23:12:58 +0000
commitad752eab7e8fbad49b6fbe4a023c71f97b8a9fa1 (patch)
treeff97d7f86c09fa924b189b1f51c67af324bbbac5 /Master/texmf-dist/doc/latex/binarytree/README
parent6b200dd5c2335baa8c78037d8f1c75d1295187f4 (diff)
binarytree (26jul16)
git-svn-id: svn://tug.org/texlive/trunk@41777 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/binarytree/README')
-rw-r--r--Master/texmf-dist/doc/latex/binarytree/README50
1 files changed, 41 insertions, 9 deletions
diff --git a/Master/texmf-dist/doc/latex/binarytree/README b/Master/texmf-dist/doc/latex/binarytree/README
index 3cc69561cba..45af80d50e3 100644
--- a/Master/texmf-dist/doc/latex/binarytree/README
+++ b/Master/texmf-dist/doc/latex/binarytree/README
@@ -13,18 +13,39 @@ and version 1.3 or later is part of all distributions of
LaTeX version 2005/12/01 or later.
=========================== ABOUT ==========================
-The 'binarytree' package provides an easy but flexible way to draw binary trees using TikZ. It provides a macro \BinaryTree which takes two arguments: a path specification and a number indicating the maximum depth of the tree. The path specification and the setting of various options determine the style for each edge of the tree. The options can be set either by passing them as an optional argument to \BinaryTree, or by calling \btreeset.
+The 'binarytree' package provides an easy but flexible way
+to draw binary trees using TikZ. It provides a macro
+\BinaryTree which takes two arguments: a path specification
+and a number indicating the maximum depth of the tree. The
+path specification and the setting of various options
+determine the style for each edge of the tree. The options
+can be set either by passing them as an optional argument to
+\BinaryTree, or by calling \btreeset.
-There is support for the external library of TikZ which does not affect externalization of the rest of the TikZ figures in the document (externalization is enabled locally for each \BinaryTree). There is an option to use automatic file naming: this is useful if the trees are often moved around or new ones are added in between, in which case using the default naming will cause all of them to be rebuilt. Instead, giving a unique name to each tree will have TikZ use the already compiled image no matter where in the document it is or how many times it has been used. This feature is still in its very infancy and more control over how the file name is generated is planned for the future.
+There is support for the external library of TikZ which does
+not affect externalization of the rest of the TikZ figures
+in the document (externalization is enabled locally for each
+\BinaryTree). There is an option to use automatic file
+naming: this is useful if the trees are often moved around
+or new ones are added in between, in which case using the
+default naming will cause all of them to be rebuilt.
+Instead, giving a unique name to each tree will have TikZ
+use the already compiled image no matter where in the
+document it is or how many times it has been used. This
+feature is still in its very infancy and more control over
+how the file name is generated is planned for the future.
======================= INSTALLATION =======================
Extract all of the files and run latex on binarytree.ins:
latex binarytree.ins
-Move the generated binarytree.sty into a TeX searchable directory, for example on Linux:
+Move the generated binarytree.sty into a TeX searchable
+directory, for example on Linux:
mkdir -p <TeX folder>/tex/latex/binarytree
mv binarytree.sty <TeX folder>/tex/latex/binarytree
-for example the local user TeX directory is in 'C:\Documents and Settings\<user name>\texmf' on Windows, '~/texmf' on Linux or '~/Library/texmf' on OS X.
+The local user TeX directory is in
+'C:\Documents and Settings\<user name>\texmf' on Windows,
+'~/texmf' on Linux or '~/Library/texmf' on OS X.
If you wish to (re)create the documentation:
pdflatex binarytree.dtx
@@ -35,14 +56,25 @@ If you wish to (re)create the documentation:
pdflatex binarytree.dtx
========================== TESTING =========================
-Provided are four files to test the package (also included as examples in the documentation:
-* 'examples/binarytree-ex1.tex' draws two trees, names them as nodes and uses them in a simple graph. To recompile it, simply run:
+Provided are four files to test the package (also included
+as examples in the documentation:
+* 'examples/binarytree-ex1.tex' draws two trees, names them
+ as nodes and uses them in a simple graph. To recompile it,
+ simply run:
pdflatex examples/binarytree-ex1.tex
-* 'examples/binarytree-ex2.tex' draws 4 identically structured trees using different level and sibling distance scalings. To recompile it, simply run:
+* 'examples/binarytree-ex2.tex' draws 4 identically
+ structured trees using different level and sibling
+ distance scalings. To recompile it, simply run:
pdflatex examples/binarytree-ex2.tex
-* 'examples/binarytree-ex3.tex' draws a square with arrows on each side! To recompile it, simply run:
+* 'examples/binarytree-ex3.tex' draws a square with arrows
+ on each side! To recompile it, simply run:
pdflatex examples/binarytree-ex3.tex
-* 'examples/binarytree-ex4.tex' draws a similar square twice and exports them using the external library. It uses the 'list and make' mode, so it generates 'examples/binarytree-ex4.figlist' and 'examples/binarytree-ex4.makefile', requiring manual compilation of the exported figure:
+* 'examples/binarytree-ex4.tex' draws a similar square twice
+ and exports them using the external library. It uses the
+ 'list and make' mode, so it generates
+ 'examples/binarytree-ex4.figlist' and
+ 'examples/binarytree-ex4.makefile', requiring manual
+ compilation of the exported figure:
pdflatex examples/binarytree-ex4.tex
make -f examples/binarytree-ex4.makefile
pdflatex examples/binarytree-ex4.tex