Debian Codegraph @

texmf-dist/doc/latex/tikzquads/README.md

raw
1 tikzquads
2 ==========
3
4 This package defines a few extra shapes (single / dual port boxes) designed to be used together with
5 the CircuiTikZ package.
6
7
8 For more details, see the (some) documentation,
9
10 [tikzquads.pdf](http://mirrors.ctan.org/graphics/pgf/contrib/tikzquads/doc/tikzquads.pdf)
11
12 --------------
13
14 ## Requirements
15 * none besides a fairly recent LaTeX distribution as recent as 2022/06/01
16 (with the new in kernel *\ProcessKeyOptions* and *\NewDocumentCommand*)
17
18 and pgf/TikZ or CircuiTikZ
19
20 ## Installation
21 The stable version is available at [CTAN](https://ctan.org/pkg/tikzquads).
22
23 ## Usage
24 ### Stable version
25 Just place
26 ```latex
27 \usepackage{tikzquads}
28 ```
29
30 in the preamble and compile away.
31
32
33 Be aware that options might change between versions, so you have to check them manually.
34
35
36 ## More Information and documentation
37 More Information can be found in the documentation; you can find a "bleeding edge" version
38 at [the github page](http://github.com/alceu-frigeri/tikzquads)
39
40 ## Contacting Author
41
42 For bug reports and enhancement suggestions, the preferred way is to use
43 [the project's issue page](https://github.com/alceu-frigeri/tikzquads/issues).
44 Please be ready to provide an example code showing the bug, if any.
45
46 Please do not use the issue page for generic help on how to use the package.
47
48 * git: https://github.com/alceu-frigeri/tikzquads
49
50 -------------
51 Copyright 2024-present by Alceu Frigeri
52
53 This work may be distributed and/or modified under the
54 conditions of
55
56 * The [LaTeX Project Public License](http://www.latex-project.org/lppl.txt), version 1.3c (or later), and/or
57 * The [GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.html), version 3 (or later)
58
59 This work has the LPPL maintenance status *maintained*.
60
61 The Current Maintainer of this work is Alceu Frigeri
62
63 -------------
64 ## This work consists of the files
65
66 * tikzquads.sty
67 - The Package itself
68
69 * README.md (this file)
70 - quick introduction
71
72 * tikzquads.bib
73 * tikzquads.tex
74 - package documentation
75
76 * tikzquads.pdf
77 - documentation in PDF format
78
79 -------------
80
81 ## Changelog
82 * Version 1.2a (this)
83 - switching over 'pkginfograb' package's info
84 - using new pgfkeysearch variants.
85 - removing references to kernel scratch variables.
86 - newcommand (almost all) => NewDocumentCommand (some remained, due to expansion)
87
88 * Version 1.2
89 - Added \QuadParConnect command (see manual)
90
91 * Version 1.1
92 - Added a 'raw sources' key (see manual)
93 - a few typos in the documentation
94
95 * Version 1.0
96 - Initial release by CTAN