docs: 📝 Update README

This commit is contained in:
Louis Gallet 2024-11-25 15:52:05 +01:00
parent 3f97bb69c1
commit 11fa2381c0
Signed by: lgallet
GPG Key ID: 84D3DF1528A84511

View File

@ -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