mirror of
https://github.com/qurator-spk/dinglehopper.git
synced 2025-06-20 00:59:58 +02:00
📝 dinglehopper: Document installation + testing
This commit is contained in:
parent
58ff140bc0
commit
1206c9bb4b
1 changed files with 18 additions and 0 deletions
18
README.md
18
README.md
|
@ -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.
|
|||
|
||||
|
||||

|
||||
|
||||
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…
Add table
Add a link
Reference in a new issue