Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation: README completness, debug ocrd-tool.json #1

Open
tboenig opened this issue Oct 23, 2019 · 1 comment
Open

documentation: README completness, debug ocrd-tool.json #1

tboenig opened this issue Oct 23, 2019 · 1 comment

Comments

@tboenig
Copy link

tboenig commented Oct 23, 2019

Please debug your ocrd_tool.json file.
I found an error:

<report valid="false">
  <error>NO ocrd-tool.json</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. Your README is fine but look at your file and compare your's with the ideal README file.

# Name of application


## Introduction
...

## Installation
...

## Usage
...

## Testing
...

Thank you very much.

@crater2150
Copy link
Contributor

The error with the ocrd_tool.json was, that it wasn't there. The repo now contains one which should be correct.

I've also restructured the README, but the "Testing" section is still missing. I'll try to add a testing procedure soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants