📝 dinglehopper: Document installation + testing

pull/29/head
Gerber, Mike 5 years ago
parent 58ff140bc0
commit 1206c9bb4b

@ -13,6 +13,13 @@ Goals
* As a library * As a library
* Unicode support * Unicode support
Installation
------------
It's best to use pip, e.g.:
~~~
sudo pip install .
~~~
Usage 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) ![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
~~~

Loading…
Cancel
Save