docs: 📝 Update README
This commit is contained in:
parent
3f97bb69c1
commit
11fa2381c0
12
README.md
12
README.md
@ -1,3 +1,15 @@
|
|||||||
# OCR Dataset Generator
|
# OCR Dataset Generator
|
||||||
Python script that generates datasets for the recognition of text written in different fonts.
|
Python script that generates datasets for the recognition of text written in different fonts.
|
||||||
The images generated are in 13x13 format and are all arranged in alphabetical order.
|
The images generated are in 13x13 format and are all arranged in alphabetical order.
|
||||||
|
|
||||||
|
## How to use this script
|
||||||
|
### Install required library
|
||||||
|
```shell
|
||||||
|
pip install -r requirements.txt
|
||||||
|
```
|
||||||
|
### Execute the script
|
||||||
|
```shell
|
||||||
|
python main.py <number-of-letter> <google-font-api-key>
|
||||||
|
```
|
||||||
|
`nubmer-of-letter`: the number of different font for each letter to be generated
|
||||||
|
`google-font-api-key`: Your Google Font API key. Can be generated from here: https://developers.google.com/fonts/docs/developer_api
|
||||||
|
Reference in New Issue
Block a user