summaryrefslogtreecommitdiff
path: root/macros/luatex/optex/pdfextra/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/luatex/optex/pdfextra/README.md')
-rw-r--r--macros/luatex/optex/pdfextra/README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/macros/luatex/optex/pdfextra/README.md b/macros/luatex/optex/pdfextra/README.md
new file mode 100644
index 0000000000..c47262b1f5
--- /dev/null
+++ b/macros/luatex/optex/pdfextra/README.md
@@ -0,0 +1,35 @@
+# PDF Extra
+
+PDF Extra provides extra PDF features for OpTeX.
+
+As a minimalistic package OpTeX doesn't support "advanced" features of PDF file
+format in the base. This third party package aims to provide them. Summary of
+supported features:
+
+ - insertion of multimedia (audio, video, 3D);
+ - hyperlinks and other actions,
+ - trigger events;
+ - transitions;
+ - attachments.
+
+The repository of PDF Extra is at https://github.com/vlasakm/pdfextra.
+
+# Documentation
+
+See `pdfextra-doc.pdf` for documentation. It contains user documentation as
+well as technical documentation interleaved with source code.
+
+# Installation instructions
+
+Put `pdfextra.opm` where `optex` can find it.
+
+Or just copy paste anything you want.
+
+# Usage
+
+In OpTex do: `\load [pdfextra]`.
+
+# License
+
+This package is available under the Zero-Clause BSD license. See `LICENSE` for
+more information.