summaryrefslogtreecommitdiff
path: root/support/pkgcheck/README.md
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 /support/pkgcheck/README.md
Initial commit
Diffstat (limited to 'support/pkgcheck/README.md')
-rw-r--r--support/pkgcheck/README.md66
1 files changed, 66 insertions, 0 deletions
diff --git a/support/pkgcheck/README.md b/support/pkgcheck/README.md
new file mode 100644
index 0000000000..96d6b16716
--- /dev/null
+++ b/support/pkgcheck/README.md
@@ -0,0 +1,66 @@
+---
+pkgcheck utility
+
+Author: Manfred Lotz, <manfred@ctan.org>
+
+License: Apache License, Version 2.0 or MIT License
+
+---
+
+
+# Overview
+
+`pkgcheck` is a utility which the author uses to check uploaded packages to CTAN before
+installing them. It is a binary running on Linux only.
+
+There is no Windows version planned.
+
+
+# Dependencies
+
+The `pkgcheck` binary is a 64-bit statically linked binary, and thus it should run also on
+older Linux versions.
+
+It uses the following external programs:
+
+- `pdfinfo` for checking pdf documents
+- `unzip` for temporarily unpacking a TDS zip archive
+
+# Installing the binary
+
+Copy the binary from `bin/pkgcheck` to a suitable location on your hard disk, and
+(recommended) make sure the directory is in the `PATH` or call `pkgcheck` using an
+absolute path name.
+
+# Documentation
+
+The documentation is `docs/pkgcheck.pdf`. It contains
+a description of all fatal, error, warning and information messages.
+
+
+# Build the documentation
+
+Run either `xelatex` or `lualatex`. Note that `-shell-escape` is required.
+
+
+```
+cd docs
+lualatex -shell-escape pkgcheck.tex
+```
+
+
+
+# License
+
+Licensed under either of
+
+- Apache License, Version 2.0
+
+ - See file LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0
+
+- MIT license
+
+ - See file LICENSE-MIT or http://opensource.org/licenses/MIT
+
+at your option.
+