From 82ee93b53ae4fcef619543f643dc626f6c9353cf Mon Sep 17 00:00:00 2001 From: Nick White Date: Wed, 18 Nov 2020 13:47:44 +0000 Subject: Describe rescribe tool in documentation --- README | 12 ++++++------ doc.go | 11 ++++------- 2 files changed, 10 insertions(+), 13 deletions(-) diff --git a/README b/README index 681d731..0d2119b 100644 --- a/README +++ b/README @@ -46,19 +46,19 @@ setting: - pdfbook : creates a searchable PDF from a directory of hOCR and image files -## Local operation +## Rescribe tool for 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: +Several of the commands accept a `-c local` flag for local operation, but now +there is also a new command, named `rescribe`, that is designed to make things +much simpler for people just wanting to do some OCR on their local computer. - booktopipeline -c local MyBook - bookpipeline -v -c local # run until MyBook has finished processing - getpipelinebook -c local MyBook +More information about this, including links to prebuilt executables, can be +found on our blog at . ## Contributions diff --git a/doc.go b/doc.go index 179a4f3..bd4da11 100644 --- a/doc.go +++ b/doc.go @@ -174,14 +174,11 @@ 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 and so on that the pipeline provides. +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 +Several of the commands accept a `-c local` flag for local operation, but now +there is also a new command, named rescribe, that is designed to make things +much simpler for people just wanting to do some OCR on their local computer. Note that the local mode is not as well tested as the core cloud modes; please report any bugs you find with it. -- cgit v1.2.1-24-ge1ad