diff options
| author | Nick White <git@njw.name> | 2020-11-18 13:47:44 +0000 |
|---|---|---|
| committer | Nick White <git@njw.name> | 2020-11-18 13:47:44 +0000 |
| commit | 82ee93b53ae4fcef619543f643dc626f6c9353cf (patch) | |
| tree | b7c80b1530501945c31ba48731e7311d06d685c8 | |
| parent | 2717c5ed21a082a7f24833f3d57b303fd22bd4e5 (diff) | |
Describe rescribe tool in documentationv0.3.1
| -rw-r--r-- | README | 12 | ||||
| -rw-r--r-- | doc.go | 11 |
2 files changed, 10 insertions, 13 deletions
@@ -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 @@ -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. |