diff options
author | Nick White <git@njw.name> | 2020-11-06 16:57:20 +0000 |
---|---|---|
committer | Nick White <git@njw.name> | 2020-11-06 16:57:20 +0000 |
commit | ad4416a7d53e3fb783d15a67095994a7623bf109 (patch) | |
tree | 83608d84f536a5ec47d614084861449cca6fe41d /README | |
parent | e9f6e6546ba6f8039897fe8e4396858f300af217 (diff) |
Document the local mode
Diffstat (limited to 'README')
-rw-r--r-- | README | 14 |
1 files changed, 14 insertions, 0 deletions
@@ -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 |