diff --git a/README.md b/README.md index e7b28fd..bf1fd89 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,22 @@ # Textline-Recognition -*** -# Tool -This tool does textline detection of image and throw result as xml data. +## Introduction +This tool performs textline detection from document image data and returns the results as PAGE-XML. -# Models -In order to run this tool you need corresponding models. You can find them here: +## Installation -https://file.spk-berlin.de:8443/textline_detection/ - -# Installation - -sudo pip install . +`pip install .` -# Usage +## Models +In order to run this tool you also need trained models. You can download our pre-trained models from here: +https://file.spk-berlin.de:8443/textline_detection/ -sbb_textline_detector -i 'image file name' -o 'directory to write output xml' -m 'directory of models' +## Usage +`sbb_textline_detector -i -o -m ` ## Usage with OCR-D + ~~~ ocrd-example-binarize -I OCR-D-IMG -O OCR-D-IMG-BIN ocrd_sbb_textline_detector -I OCR-D-IMG-BIN -O OCR-D-SEG-LINE-SBB \ @@ -29,4 +27,4 @@ Segmentation works on raw RGB images, but respects and retains `AlternativeImage`s from binarization steps, so it's a good idea to do binarization first, then perform the textline detection. The used binarization processor must produce an `AlternativeImage` for the binarized image, not -replace the original raw RGB image. +replace the original raw RGB image. \ No newline at end of file