From d9161a6ddb7e8a89c53ede6ee5e0652c1e22e7b3 Mon Sep 17 00:00:00 2001 From: jbarlow83 Date: Sat, 22 Aug 2015 01:50:13 -0700 Subject: [PATCH] Update README: docker run instructions --- README.rst | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index f3d49c3d..40c6468a 100644 --- a/README.rst +++ b/README.rst @@ -63,22 +63,30 @@ a Docker container of the latest release. Follow the Docker installation instructions for your platform. If you can run this command successfully, your system is ready to download and execute the image:: - docker run hello-world + docker run hello-world Assuming you have a Docker engine running somewhere, you can run these commands to download the image:: - docker pull jbarlow83/ocrmypdf + docker pull jbarlow83/ocrmypdf Then give it a more friendly, local name:: - docker tag jbarlow83/ocrmypdf ocrmypdf + docker tag jbarlow83/ocrmypdf ocrmypdf You can then run using the simple command:: - docker run ocrmypdf --help + docker run ocrmypdf --help -That's it. +To execute the OCRmyPDF on a local file, you must `provide a writable volume to the Docker image `__, such as this in this template:: + + docker run -v "$(pwd):/home/docker" ocrmypdf + +In this worked example, the current working directory contains an input file called `test.pdf` and the output will go to `output.pdf`:: + + docker run -v "$(pwd):/home/docker" ocrmypdf --skip-text test.pdf output.pdf + +Note that `ocrmypdf` has its own separate -v argument to control debug verbosity. Installing on Mac OS X Yosemite ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -118,9 +126,6 @@ The command line program should now be available:: ocrmypdf --help - - - Installing on Ubuntu 14.04 LTS ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -163,6 +168,8 @@ package `__ for an example of how to building unpaper 6.1 from source. If you choose to install unpaper later, OCRmyPDF will use the foremost version on the system PATH. + Installing HEAD revision from sources ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~