From 5da25f0aeb4f4c185184e0fed77c1c1f6e849603 Mon Sep 17 00:00:00 2001 From: "Gerber, Mike" Date: Mon, 2 Mar 2020 18:52:34 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20README:=20Use=20the=20image=20fr?= =?UTF-8?q?om=20Docker=20Hub?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5f61ee3..cb01bd6 100644 --- a/README.md +++ b/README.md @@ -19,13 +19,9 @@ Provide a **test environment** to produce OCR output for historical prints, usin How to use ---------- -It's easiest to use it as a container. To build the container using Docker: -~~~ -cd ~/devel/my_ocrd_workflow -./build -~~~ +It's easiest to use it as a pre-built container. To run the container on an +example workspace: -To run the container on an example workspace: ~~~ # Download an example workspace cd /tmp @@ -34,8 +30,17 @@ unzip actevedef_718448162.first-page.zip # Run the workflow on it cd actevedef_718448162.first-page -~/devel/my_ocrd_workflow/run +~/devel/my_ocrd_workflow/run-docker-hub +~~~ + +### Build the container yourself +To build the container yourself using Docker: +~~~ +cd ~/devel/my_ocrd_workflow +./build ~~~ +You may then use the script `run` to use your self-built container, analogous to +the example above. ### Viewing results You may then examine the results using