qurator-spk/dinglehopper
1
0
Fork 0
mirror of https://github.com/qurator-spk/dinglehopper.git synced 2025-06-30 22:19:57 +02:00
Code Issues Releases Wiki Activity

📝 dinglehopper: Document installation + testing

Browse source
This commit is contained in:
Gerber, Mike 2019-11-18 16:32:42 +01:00
parent 58ff140bc0
commit 1206c9bb4b
1 changed files with 18 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -13,6 +13,13 @@ Goals
* As a library
* Unicode support
Installation
------------
It's best to use pip, e.g.:
~~~
sudo pip install .
~~~
Usage
-----
~~~
@ -29,3 +36,14 @@ This generates HTML and JSON reports in the `OCR-D-OCR-TESS-EVAL` filegroup.
![dinglehopper displaying metrics and character differences](.screenshots/dinglehopper.png?raw=true)
Testing
-------
Use `pytest` to run the tests in [the tests directory](qurator/dinglehopper/tests):
~~~
virtualenv -p /usr/bin/python3 venv
. venv/bin/activate
pip install -r requirements.txt
pip install pytest
pytest
~~~