aboutsummaryrefslogtreecommitdiffstats
path: root/README-doc.txt
diff options
context:
space:
mode:
authorJay Berkenbilt <ejb@ql.org>2021-12-21 15:23:20 +0100
committerJay Berkenbilt <ejb@ql.org>2021-12-21 15:52:41 +0100
commit36916619f0b07b4412df5a96683579552dd96285 (patch)
tree29df82de9a033570826c2791f9b6457ac7b63bd5 /README-doc.txt
parente058247bcfb132866dae5c873db7591bcc13db7e (diff)
downloadqpdf-36916619f0b07b4412df5a96683579552dd96285.tar.zst
Stop adding pre-built documentation to the source distribution
Diffstat (limited to 'README-doc.txt')
-rw-r--r--README-doc.txt20
1 files changed, 20 insertions, 0 deletions
diff --git a/README-doc.txt b/README-doc.txt
new file mode 100644
index 00000000..8f7ea35f
--- /dev/null
+++ b/README-doc.txt
@@ -0,0 +1,20 @@
+WHERE TO FIND THE QPDF DOCUMENTATION
+
+Complete documentation for qpdf can be found online here:
+https://qpdf.readthedocs.io
+
+Some distributions include offline documentation typically in a
+location such as /usr/share/doc/qpdf. If it isn't there, you can find
+a zip file containing the documentation in the qpdf release area:
+https://github.com/qpdf/qpdf/releases
+
+Offline documentation contains the following:
+
+* PDF: qpdf-manual.pdf
+* HTML: html/index.html
+* SINGLE-PAGE HTML: singlehtml/index.html
+
+If you are reading this file from the source distribution, you can
+find the documentation sources in the "manual" directory. There is
+information in the manual about how to build and package the
+documentation.