From 11fa2381c03e9b8e8497970fb0a0e603a3afb944 Mon Sep 17 00:00:00 2001 From: Louis Gallet Date: Mon, 25 Nov 2024 15:52:05 +0100 Subject: [PATCH] docs: :pencil: Update README --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e920fb2..962adf1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ # OCR Dataset Generator 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. \ No newline at end of file +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 +``` +`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