From e9f6e6546ba6f8039897fe8e4396858f300af217 Mon Sep 17 00:00:00 2001 From: Nick White Date: Fri, 6 Nov 2020 16:44:42 +0000 Subject: Add git clone advice to readme --- README | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'README') diff --git a/README b/README index 6829c1c..2f1a95a 100644 --- a/README +++ b/README @@ -9,6 +9,11 @@ by running `go get rescribe.xyz/bookpipeline/...` and documentation can be read with the `go doc` command or online at . +If you just want to install and use the commands, you can get the +package with `git clone https://git.rescribe.xyz/bookpipeline`, and +then install them with `go install ./...` from within the +`bookpipeline` directory. + ## Commands The commands in the cmd/ directory are at the heart of this -- cgit v1.2.1-24-ge1ad 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 From 48f817f0dfd3e89c372ac358418fe69b43eefa1b Mon Sep 17 00:00:00 2001 From: Nick White Date: Fri, 6 Nov 2020 17:00:12 +0000 Subject: Fix the README to be valid markdown in the local example --- README | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'README') diff --git a/README b/README index 22c4bbc..681d731 100644 --- a/README +++ b/README @@ -56,9 +56,9 @@ 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 + booktopipeline -c local MyBook + bookpipeline -v -c local # run until MyBook has finished processing + getpipelinebook -c local MyBook ## Contributions -- cgit v1.2.1-24-ge1ad 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 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'README') 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 -- cgit v1.2.1-24-ge1ad