OCR-D / ocrd_kraken

Wrapper for the kraken OCR engine
Apache License 2.0
11 stars 6 forks source link

documentation: README completeness, debug ocrd-tool.json #29

Closed tboenig closed 1 year ago

tboenig commented 5 years ago

Please debug your ocrd_tool.json file. I found some errors:

<report valid="false">
  <error>[tools.ocrd-kraken-binarize.input_file_grp] 'OCR-D-IMG' is not of type 'array'</error>
  <error>[tools.ocrd-kraken-binarize.output_file_grp] 'OCR-D-IMG-BIN' is not of type 'array'</error>
  <error>[tools.ocrd-kraken-binarize.parameters.level-of-operation] 'description' is a required property</error>
  <error>[tools.ocrd-kraken-segment] 'input_file_grp' is a required property</error>
  <error>[tools.ocrd-kraken-segment] 'output_file_grp' is a required property</error>
  <error>[tools.ocrd-kraken-segment.parameters.maxcolseps] 'description' is a required property</error>
  <error>[tools.ocrd-kraken-segment.parameters.scale] 'description' is a required property</error>
  <error>[tools.ocrd-kraken-segment.parameters.black_colseps] 'description' is a required property</error>
  <error>[tools.ocrd-kraken-segment.parameters.white_colseps] 'description' is a required property</error>
  <error>[tools.ocrd-kraken-ocr] 'input_file_grp' is a required property</error>
  <error>[tools.ocrd-kraken-ocr] 'output_file_grp' is a required property</error>
  <error>[tools.ocrd-kraken-ocr.parameters.lines-json.required] 'true' is not of type 'boolean'</error>
</report>

You can find the ocrd-tool.json documentation: https://ocr-d.github.io/ocrd_tool

Please check your README file and complet them. An ideal README file look like:

# Name of application

## Introduction
...

## Installation
...

## Usage
...

## Testing
...

Thank you very much.

kba commented 4 years ago

Module is currently not implemented fully and I do not foresee spare time to fix and improve. Best course of action would be to add "Unmaintained" warnings to the README, archive the repo and stop any work until/if we find the time to work on it.

bertsky commented 1 year ago

Solved along with #33.