summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README12
1 files changed, 6 insertions, 6 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 <https://blog.rescribe.xyz/posts/desktop-tool/>.
## Contributions