summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/bitpattern/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/bitpattern/README.md')
-rw-r--r--macros/latex/contrib/bitpattern/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/macros/latex/contrib/bitpattern/README.md b/macros/latex/contrib/bitpattern/README.md
new file mode 100644
index 0000000000..4333b77218
--- /dev/null
+++ b/macros/latex/contrib/bitpattern/README.md
@@ -0,0 +1,20 @@
+# bitpattern LaTeX package
+
+A LaTeX package by Jean-Marc Bourguet <jm@bourguet.org> to generate bit
+pattern diagrams such as those used to describe hardware, data format or
+protocols.
+
+Run LaTeX on the file `bitpattern.ins` to get a .sty to place in your tex
+hierarchy.
+
+Run LaTeX on the file `bitpattern.dtx` to get a manual. If the
+`\OnlyDescription` command is commented out, you get commented sources in
+the manual, else you get only the user's manual part.
+
+This program is provided under the terms of the LaTeX Project Public
+License distributed from CTAN archives in directory
+macros/latex/base/lppl.txt.
+
+This program is hosted at `https://bitbucket.org/bourguet/bitpattern`. The
+best way to report issues and to suggest improvements is with the issue
+tracker there.