mirror of
https://github.com/qurator-spk/ocrd-galley.git
synced 2025-06-09 06:39:53 +02:00
🧹 Update README for the newest changes + clean-up
This commit is contained in:
parent
53d752f58d
commit
5bf350056f
2 changed files with 18 additions and 26 deletions
33
README.md
33
README.md
|
@ -27,13 +27,25 @@ including all dependencies in Docker.
|
|||
|
||||
How to use
|
||||
----------
|
||||
It's easiest to use it as pre-built containers. To run the containers on an
|
||||
example workspace:
|
||||
**Currently, due to problems with the Travis CI, we do not provide pre-built
|
||||
containers anymore.***
|
||||
|
||||
To build the containers yourself using Docker:
|
||||
~~~
|
||||
cd ~/devel/ocrd-galley/
|
||||
./build
|
||||
~~~
|
||||
|
||||
You can then install the wrappers into a Python venv:
|
||||
~~~
|
||||
cd ~/devel/ocrd-galley/wrapper
|
||||
pip install .
|
||||
~~~
|
||||
|
||||
You may then use the script `my_ocrd_workflow` to use your self-built
|
||||
containers on an example workspace:
|
||||
|
||||
~~~
|
||||
# Update to the latest stable containers
|
||||
(cd ~/devel/ocrd-galley/; ./run-docker-hub-update)
|
||||
|
||||
# Download an example workspace
|
||||
cd /tmp
|
||||
wget https://qurator-data.de/examples/actevedef_718448162.first-page.zip
|
||||
|
@ -41,18 +53,9 @@ unzip actevedef_718448162.first-page.zip
|
|||
|
||||
# Run the workflow on it
|
||||
cd actevedef_718448162.first-page
|
||||
~/devel/ocrd-galley/run-docker-hub
|
||||
~/devel/ocrd-galley/my_ocrd_workflow
|
||||
~~~
|
||||
|
||||
### Build the containers yourself
|
||||
To build the containers yourself using Docker:
|
||||
~~~
|
||||
cd ~/devel/ocrd-galley/
|
||||
./build
|
||||
~~~
|
||||
You may then use the script `run` to use your self-built containers, analogous to
|
||||
the example above.
|
||||
|
||||
### Viewing results
|
||||
You may then examine the results using
|
||||
[PRImA's PAGE Viewer](https://www.primaresearch.org/tools/PAGEViewer):
|
||||
|
|
|
@ -1,11 +0,0 @@
|
|||
#!/bin/sh
|
||||
# Update the my_ocrd_workflow containers
|
||||
|
||||
DOCKER_IMAGE_PREFIX=mikegerber/my_ocrd_workflow
|
||||
DOCKER_IMAGE_TAG=stable
|
||||
|
||||
|
||||
sub_images=`ls -1 Dockerfile-* | sed 's/Dockerfile-//'`
|
||||
for x in $sub_images; do
|
||||
docker pull $DOCKER_IMAGE_PREFIX-$x:$DOCKER_IMAGE_TAG
|
||||
done
|
Loading…
Add table
Add a link
Reference in a new issue