summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/pgfopts/README
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/pgfopts/README
Initial commit
Diffstat (limited to 'macros/latex/contrib/pgfopts/README')
-rw-r--r--macros/latex/contrib/pgfopts/README33
1 files changed, 33 insertions, 0 deletions
diff --git a/macros/latex/contrib/pgfopts/README b/macros/latex/contrib/pgfopts/README
new file mode 100644
index 0000000000..4174b034eb
--- /dev/null
+++ b/macros/latex/contrib/pgfopts/README
@@ -0,0 +1,33 @@
+pgfopts - LaTeX package options with pgfkeys
+============================================
+
+Using key-value options for packages and macros is a good way of
+handling large numbers of options with a clean interface. The
+`pgfkeys` package provides a very well designed system for
+defining and using keys, but does not make this available for
+handling LaTeX class and package options. The `pgfopts` package
+adds this ability to `pgfkeys`, in the same way that `kvoptions`
+extends the `keyval` package.
+
+Installation
+------------
+
+The package is supplied in `.dtx` format and as a pre-extracted
+zip file, `pgfopts.tds.zip`. The later is most convenient for
+most users: simply unzip this in your local `texmf` directory.
+If you want to unpack the `.dtx` yourself, running `tex
+pgfopts.dtx` will extract the package whereas 'latex pgfopts.dtx
+will extract it and also typeset the documentation.
+
+Typesetting the documentation requires a number of packages in
+addition to those needed to use the package. This is mainly
+because of the number of demonstration items included in the
+text. To compile the documentation without error, you will
+need the packages:
+ - `csquotes`
+ - `helvet`
+ - `hypdoc`
+ - `listings`
+ - `lmodern`
+ - `mathpazo`
+ - `microtype` \ No newline at end of file