From 7c20325f6b11e3ed00a85c64f7c9bc2ab05cd4e2 Mon Sep 17 00:00:00 2001 From: Jags-08 Date: Wed, 6 May 2026 02:07:06 +0530 Subject: [PATCH] Improve README formatting and add usage example --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fd3aeca98..4450c120a 100644 --- a/README.md +++ b/README.md @@ -152,7 +152,7 @@ More details on pip install openCV [here](https://www.pyimagesearch.com/2018/09/ Installing missing libraries(if any): -On a fresh computer, some of the libraries may get missing in event after a successful pip install. Install them using following commands[(ref)](https://www.pyimagesearch.com/2018/05/28/ubuntu-18-04-how-to-install-opencv/): +On a fresh computer, some libraries may be missing even after a successful pip install. Install them using following commands[(ref)](https://www.pyimagesearch.com/2018/05/28/ubuntu-18-04-how-to-install-opencv/): ```bash sudo apt-get install -y build-essential cmake unzip pkg-config @@ -249,6 +249,21 @@ Explanation for the arguments: - The `--template` flag is deprecated and instead it's recommended to keep the template file at the parent folder containing folders of different images +## Usage Example + +Here is a simple example of how to use OMRChecker in a complete workflow: + +1. Place your scanned OMR sheets in a folder, such as `inputs/`. +2. Create or copy your layout definition into a `template.json` file. +3. Run the checker script targeting your inputs: + +```bash +python3 main.py --inputDir inputs/ --outputDir outputs/ +``` + +4. Check the `outputs/` folder for your parsed results in CSV format and visual feedback images! + +