aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJay Berkenbilt <ejb@ql.org>2021-12-18 17:19:20 +0100
committerJay Berkenbilt <ejb@ql.org>2021-12-18 18:20:56 +0100
commit426b4ce8565e4f9143c122fd3afbcc22598fc6c4 (patch)
treef6871b378481cb421e317d13fad121f8dad31be2 /README.md
parenteb20b4d0cbdf42abb675566608f16f9a65a61c05 (diff)
downloadqpdf-426b4ce8565e4f9143c122fd3afbcc22598fc6c4.tar.zst
Update documentation build/installation
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 11777352..3e7e9eb5 100644
--- a/README.md
+++ b/README.md
@@ -68,7 +68,7 @@ The PDF file format used to rely on RC4 for encryption. Using 256-bit keys alway
# Building from a pristine checkout
-When building qpdf from a pristine checkout from version control, generated documentation files are not present. You may either generate them (by passing `--enable-doc-maintenance` to `./configure` and satisfying the extra build-time dependencies) or obtain them from a released source package, which includes them. If you want to grab just the files that are in the source distribution but not in the repository, extract a source distribution in a temporary directory, and run `make CLEAN=1 distfiles.zip`. This will create a file called `distfiles.zip`, which can you can extract in a checkout of the source repository. This step is optional unless you are running make install and want the html and PDF versions of the documentation to be installed.
+When building qpdf from a pristine checkout from version control, generated HTML and PDF documentation files are not present. You don't need them unless you are going to run `make install` and want the documentation to be installed. If you want them, you can either extract the `doc` directory from a source distribution, or you can satisfy the additional requirements for building documentation and pass `--enable-doc-maintenance` to `./configure`.
# Building from source distribution on UNIX/Linux