From ea03514084b1a57b7752d7577e54cc3ea4297296 Mon Sep 17 00:00:00 2001 From: Jakob Haufe Date: Tue, 12 Dec 2017 22:40:12 +0100 Subject: [PATCH] Improve README --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 07d9c78..a8d3c91 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,9 @@ * Crop pages to a certain size * Adjust the crop position per page +It has been created to print sewing patterns distributed as A4 or Letter PDFs on a large format printer +thus saving oneself the hassle of cutting and gluing individual pages. + ## License `pdfstitch` is free software under the GNU AGPL version 3. See `LICENSE` for details. @@ -22,7 +25,7 @@ * PDF::API2 * YAML -On Debian, you can installed them with: +On Debian, you can install them with: `# apt install libfile-libmagic-perl libpdf-api2-perl libyaml-perl` @@ -39,25 +42,27 @@ On FreeBSD, you can install them with: This will generate a YAML file called `foobar.pdf.stitch`. Edit this file according to the desired output. This is also the default action if called with a PDF. Per default 10% (factor 0.9) is applied as crop factor. You can adjust this value with the --defaultcrop parameter. + 2. Optional: Generate a preview and/or cropped PDF: `./pdfstitch --preview foobar.pdf.stitch` This will generate a new PDF called `foobar-preview.pdf`. It contains only the pages you select in the YAML file with each page being overlayed with a transparent box - showing the are the page will be cropped to. + showing the area the page will be cropped to. `./pdfstitch --crop foobar.pdf.stitch` This will generate a new PDF called `foobar-cropped.pdf`. It contains only the pages you select in the YAML file with each page being cropped accordingly. -4. Generate the final stitched PDF: + +3. Generate the final stitched PDF: `./pdfstitch --stitch foobar.pdf.stitch` - This will generated a single-page PDF called `foobar-stitched.pdf` with all selected pages being + This will generate a single-page PDF called `foobar-stitched.pdf` with all selected pages being stitched together as specified in the YAML file. - This is also the default action if called with just a meta file. + This is also the default action if called with just a YAML file. ## Notes -- 2.39.5