diff options
author | Norbert Preining <norbert@preining.info> | 2019-12-20 03:00:48 +0000 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2019-12-20 03:00:48 +0000 |
commit | 18d9ec0eba21e6b8c55cdd50afb91c56e02ce7bf (patch) | |
tree | 56de5f55a6575a68557d5a384f57e3e8566c536d /graphics/pgf/base/README | |
parent | 3b24b0599bb35e1a3338fa33bfb24044a6125ba4 (diff) |
CTAN sync 201912200300
Diffstat (limited to 'graphics/pgf/base/README')
-rw-r--r-- | graphics/pgf/base/README | 60 |
1 files changed, 53 insertions, 7 deletions
diff --git a/graphics/pgf/base/README b/graphics/pgf/base/README index 73e99b884a..639e2763c8 100644 --- a/graphics/pgf/base/README +++ b/graphics/pgf/base/README @@ -1,10 +1,56 @@ -pgf -- A Portable Graphic Format for TeX +# pgf – A Portable Graphic Format for TeX -See the directory doc/generic/pgf for more information. See the file -doc/generic/pgf/pgfmanual.pdf for a manual. This +[![Travis Build Status][travis-svg]][travis-link] + +PGF is a TeX macro package for generating graphics. It is platform- +and format-independent and works together with the most important TeX +backend drivers, including `pdftex` and `dvips`. It comes with a +user-friendly syntax layer called Ti*k*Z. + +See the directory `doc/generic/pgf` for more information. See the file +`doc/generic/pgf/pgfmanual.pdf` (also available from +https://pgf-tikz.github.io/pgf/pgfmanual.pdf) for a manual. This documentation also explains the installation. See the file -doc/generic/pgf/license/LICENSE for license details. +`doc/generic/pgf/license/LICENSE` for license details. + +Please go to the official repository at https://github.com/pgf-tikz/pgf or the +official mailing list at https://tug.org/mailman/listinfo/pgf-tikz to submit +bug reports, request new features, etc. + +## Installation + +In general you should just use the version of PGF that is shipped by +your TeX distribution. See their documentation on how to install +packages. + +If you are feeling adventurous you can install the latest development +version in TeX Live from our tlcontrib repository. +```console +$ tlmgr repository add http://pgf-tikz.github.io/pgf/tlnet pgf-development +$ tlmgr pinning add pgf-development "*" +$ tlmgr update --self --all +$ tlmgr install pgf --reinstall +``` + +## Development + +Currently PGF does not have a comprehensive test suite to check for +regressions, so for now we check for bugs by building the manual for +each commit. To build the manual locally you can either copy the PGF +repository into your texmf tree (not recommended) or use the usertree +option of TeX Live. For the usertree option on GNU/Linux, follow +these steps: +```console +$ git clone https://github.com/pgf-tikz/pgf +$ tlmgr init-usertree --usertree pgf +$ export TEXMFHOME=`realpath pgf` +$ cd pgf/doc/generic/pgf/version-for-luatex/en/ +$ make +``` +We recommend building at least the version for LuaTeX, as shown in the +example above because this has the broadest coverage of PGF features. +To test the animations feature you have to build the version for +dvisvgm. -Please go to the official repository at https://github.com/pgf-tikz/pgf -or the official mailing list at https://tug.org/mailman/listinfo/pgf-tikz -to submit bug reports, request new features, etc. +[travis-svg]: https://travis-ci.com/pgf-tikz/pgf.svg?branch=master +[travis-link]: https://travis-ci.com/pgf-tikz/pgf |