summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/bytefield/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/bytefield/README
Initial commit
Diffstat (limited to 'macros/latex/contrib/bytefield/README')
-rw-r--r--macros/latex/contrib/bytefield/README46
1 files changed, 46 insertions, 0 deletions
diff --git a/macros/latex/contrib/bytefield/README b/macros/latex/contrib/bytefield/README
new file mode 100644
index 0000000000..e1e0d208b9
--- /dev/null
+++ b/macros/latex/contrib/bytefield/README
@@ -0,0 +1,46 @@
+ +---------------------------------+
+ | THE BYTEFIELD PACKAGE |
+ | Scott Pakin, scott+bf@pakin.org |
+ +---------------------------------+
+
+
+Description
+-----------
+
+The bytefield package helps the user create illustrations for network
+protocol specifications and anything else that utilizes fields of
+data. These illustrations show how the bits and bytes are laid out in
+a packet, register, or memory.
+
+
+Building bytefield
+------------------
+
+tex bytefield.ins <== Produces bytefield.sty (the package proper)
+latex bytefield.dtx <== Produces bytefield.dvi (the documentation)
+makeindex -s gind.ist bytefield.idx -o bytefield.ind <== Writes an index
+makeindex -s gglo.ist bytefield.glo -o bytefield.gls <== Writes a change log
+latex bytefield.dtx <== Incorporates the index and change log into
+ bytefield.dvi
+
+Note that bytefield comes with pre-built documentation. Also, there
+is an example.tex file that shows how one might include hyperlinks in
+a protocol diagram. example.tex needs the hyperref package and should
+be run through pdfLaTeX, VTeX, dvipdfm, or any other backend that
+supports hyperref hyperlinks.
+
+
+Copyright and license
+---------------------
+
+Copyright (C) 2017 Scott Pakin, scott+bf@pakin.org
+
+This package may be distributed and/or modified under the conditions
+of the LaTeX Project Public License, either version 1.3a 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.