Debian Codegraph @

texmf-dist/doc/generic/pgf/README.md

raw
1 # pgf – A Portable Graphic Format for TeX
2
3 ![Test suite](https://github.com/pgf-tikz/pgf/actions/workflows/check.yml/badge.svg?branch=master)
4
5 PGF is a TeX macro package for generating graphics. It is platform-
6 and format-independent and works together with the most important TeX
7 backend drivers, including `pdftex` and `dvips`. It comes with a
8 user-friendly syntax layer called Ti*k*Z.
9
10 See the directory `doc/generic/pgf` for more information. See the file
11 `doc/generic/pgf/pgfmanual.pdf` (also available from
12 https://pgf-tikz.github.io/pgf/pgfmanual.pdf) for a manual. This
13 documentation also explains the installation. See the file
14 `doc/generic/pgf/license/LICENSE` for license details.
15
16 Please go to the official repository at https://github.com/pgf-tikz/pgf or the
17 official mailing list at https://tug.org/mailman/listinfo/pgf-tikz to submit
18 bug reports, request new features, etc.
19
20 We also have a chat on the Matrix network at
21 [#pgf-tikz:matrix.org](https://matrix.to/#/#pgf-tikz:matrix.org).
22
23 ## Installation
24
25 In general you should just use the version of PGF that is shipped by
26 your TeX distribution. See their documentation on how to install
27 packages.
28
29 If you are feeling adventurous you can install the latest development
30 version in TeX Live from our tlcontrib repository.
31 ```console
32 $ tlmgr repository add http://pgf-tikz.github.io/pgf/tlnet pgf-development
33 $ tlmgr pinning add pgf-development "*"
34 $ tlmgr update --self --all
35 $ tlmgr install pgf --reinstall
36 ```
37
38 ## Development
39
40 Currently PGF only has a very rudimentary test suite to check for
41 regressions, so for now we check for bugs by building the manual for
42 each commit. To build the manual locally you can either copy the PGF
43 repository into your texmf tree (not recommended) or use the usertree
44 option of TeX Live. For the usertree option on GNU/Linux, follow
45 these steps:
46 ```console
47 $ git clone https://github.com/pgf-tikz/pgf
48 $ tlmgr init-usertree --usertree pgf
49 $ export TEXMFHOME=$(readlink -f pgf)
50 $ cd pgf
51 $ l3build doc -q -H
52 ```
53 We recommend building at least the version for LuaTeX, as shown in the
54 example above because this has the broadest coverage of PGF features.
55 To test the animations feature you have to build the version for
56 dvisvgm.