summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/register/README
blob: bcfbf4d89e18bbe17f24f67b87f26b391829e83f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

REGISTER
Hardware register diagrams with field descriptions.


Description
-----------

This package is designed for typesetting the programmable elements in
digital hardware, i.e., registers.  Such registers typically have many
fields and can be quite wide; they are thus a challenge to typeset in
a consistent manner.  Register is similar in some aspects to the
bytefield and bitpattern packages.  Anyone doing hardware
documentation using LaTeX should examine those packages.

Register requires version 2001/07/25 or newer of the float package.

An example Perl module and script are provided, to convert the
register specifications into structures suitable for, say, a
pre-silicon test environment.


Building package
----------------

tex register.ins       <== Produces register.sty (the package proper)
latex register.dtx     <== Produces register.dvi (the documentation)
latex register.dtx     <== Incorporates list of registers into
                            register.dvi

One can substitute pdflatex in the commands above to produce PDF
directly.

Note that register comes with pre-built documentation.  The
documentation includes some representative examples of package usage.



Copyright and license
---------------------

Copyright (C) 2001-2020 Matthew Lovell, lovells@gmail.com

This package may be distributed and/or modified under the conditions
of the LaTeX Project Public License, either version 1.3 of this
license or (at your option) any later version.  The latest version of
this license is in:

                http://www.latex-project.org/lppl.txt

and version 1.3c or later is part of all distributions of LaTeX
version 2006/05/20 or later.