From ad4416a7d53e3fb783d15a67095994a7623bf109 Mon Sep 17 00:00:00 2001 From: Nick White Date: Fri, 6 Nov 2020 16:57:20 +0000 Subject: Document the local mode --- README | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'README') diff --git a/README b/README index 2f1a95a..22c4bbc 100644 --- a/README +++ b/README @@ -46,6 +46,20 @@ setting: - pdfbook : creates a searchable PDF from a directory of hOCR and image files +## Local operation + +While bookpipeline was built with cloud based operation in mind, there is also +a local mode that can be used to run OCR jobs from a single computer, with all +the benefits of preprocessing, choosing the best threshold for each image, +graph creation, PDF creation, and so on that the pipeline provides. + +You can use this by passing the '-c local' flag to the core bookpipeline +commands. Here is a simple example run: + + booktopipeline -c local MyBook + bookpipeline -v -c local # run until MyBook has finished processing + getpipelinebook -c local MyBook + ## Contributions Any and all comments, bug reports, patches or pull requests would -- cgit v1.2.1-24-ge1ad