From cb1188e1053ef4e438f8bd2ccf8a3af835ba87d6 Mon Sep 17 00:00:00 2001 From: Jay Berkenbilt Date: Fri, 18 Oct 2013 09:21:48 -0400 Subject: [PATCH] Instructions for building from pristine checkout --- README | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/README b/README index 445849e1..5373a61e 100644 --- a/README +++ b/README @@ -76,8 +76,32 @@ That code has the following license: SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -Building on UNIX/Linux -====================== +Building from a pristine checkout +================================= + +When building qpdf from a pristine checkout from version control, +documentation and automatically generated files are not present. +Building on Windows from a pristine checkout is not guaranteed to work +because of issues running autoconf; see README-windows.txt for how to +handle this. For UNIX and UNIX-like systems, you must have some +addditional tools installed to build from the source repository. To +do this, you should run + +./autogen.sh +./configure --enable-doc-maintenance +make +make install + +If you don't have Apache fop and the docbook stylesheets installed, +you won't be able to build documentation. You can omit +--enable-doc-maintenance and produce working qpdf software that passes +its test suite, but make install will fail because the documentation +files won't exist. Depending on your purposes, you can either work +around this or grab the docs from a source distribution. + + +Building from source distribution on UNIX/Linux +=============================================== For UNIX and UNIX-like systems, you can usually get by with just