summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/register/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/register/README
Initial commit
Diffstat (limited to 'macros/latex/contrib/register/README')
-rw-r--r--macros/latex/contrib/register/README52
1 files changed, 52 insertions, 0 deletions
diff --git a/macros/latex/contrib/register/README b/macros/latex/contrib/register/README
new file mode 100644
index 0000000000..f250c7dbc2
--- /dev/null
+++ b/macros/latex/contrib/register/README
@@ -0,0 +1,52 @@
+
+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 package. Anyone doing hardware documentation using LaTeX
+should examine both 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-2018 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.
+