Improve README formatting and add usage example

[Jags-08]

This PR improves the README by enhancing formatting and adding a basic usage example to make the project easier to understand.

Let me know if any changes are needed.

[qodo-free-for-open-source-projects]

Review Summary by Qodo

Improve README with grammar fixes and usage example

📝 Documentation

Walkthroughs

Description

• Fix grammar in library installation section
• Add comprehensive usage example with step-by-step instructions
• Improve README clarity for new users

Diagram

flowchart LR
  A["README.md"] -->|"Grammar correction"| B["Installation section"]
  A -->|"Add new section"| C["Usage Example"]
  C -->|"Includes"| D["Step-by-step workflow"]
  C -->|"Includes"| E["Code snippet"]

Loading

File Changes

1. README.md 📝 Documentation +16/-1

Grammar fixes and usage example section

• Fixed grammar in library installation section: "some of the libraries may get missing in event" →
 "some libraries may be missing even after"
• Added new "Usage Example" section with step-by-step instructions for running OMRChecker
• Provided practical example showing input/output directory usage with main.py command
• Included guidance on checking outputs folder for CSV results and visual feedback

README.md

---

[qodo-free-for-open-source-projects]

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (0)

1. Template path requirement missing 🐞 Bug ≡ Correctness

Description

The new Usage Example does not state that template.json must be located inside the directory tree
rooted at --inputDir; if users put template.json elsewhere (e.g., repo root) and run with
--inputDir inputs/, the program raises "No template file found in the directory tree" and exits.
This makes the documented workflow fail for a common interpretation of step (2).

Code

README.md[R256-262]

+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/
+```

Evidence

The README example instructs running with --inputDir inputs/ but doesn’t specify that
template.json must be discoverable within that directory tree. The runtime logic only looks for
template.json in the current directory during recursion under the provided input root, and throws
if images are found without any template discovered in that traversed tree.

README.md[247-262]
src/entry.py[79-104]
src/entry.py[135-148]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The README "Usage Example" omits where `template.json` must be placed relative to `--inputDir`. The code only discovers `template.json` inside the directory tree rooted at the provided input directory and raises an exception if images are found without a discovered template.

## Issue Context
Users may reasonably interpret step (2) as creating `template.json` in the repo root (or current working directory) and then run `--inputDir inputs/`. That setup fails because `template.json` is not searched outside the input directory tree.

## Fix Focus Areas
- README.md[247-262]

## Suggested documentation change
Update the steps to explicitly say one of the following:
- Place `template.json` inside `inputs/` (or an ancestor directory *within* the `--inputDir` tree), e.g. `inputs/template.json`.
- Or, if you want `template.json` to live in a parent folder of multiple scan subfolders, set `--inputDir` to that parent folder (the one containing `template.json`).

Optionally add a small directory tree example to remove ambiguity.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

[qodo-free-for-open-source-projects]

1. Template path requirement missing 🐞 Bug ≡ Correctness

The new Usage Example does not state that template.json must be located inside the directory tree
rooted at --inputDir; if users put template.json elsewhere (e.g., repo root) and run with
--inputDir inputs/, the program raises "No template file found in the directory tree" and exits.
This makes the documented workflow fail for a common interpretation of step (2).

Agent Prompt

## Issue description
The README "Usage Example" omits where `template.json` must be placed relative to `--inputDir`. The code only discovers `template.json` inside the directory tree rooted at the provided input directory and raises an exception if images are found without a discovered template.

## Issue Context
Users may reasonably interpret step (2) as creating `template.json` in the repo root (or current working directory) and then run `--inputDir inputs/`. That setup fails because `template.json` is not searched outside the input directory tree.

## Fix Focus Areas
- README.md[247-262]

## Suggested documentation change
Update the steps to explicitly say one of the following:
- Place `template.json` inside `inputs/` (or an ancestor directory *within* the `--inputDir` tree), e.g. `inputs/template.json`.
- Or, if you want `template.json` to live in a parent folder of multiple scan subfolders, set `--inputDir` to that parent folder (the one containing `template.json`).

Optionally add a small directory tree example to remove ambiguity.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

[Udayraj123]

@Jags-08 can you please address this?

[Jags-08]

Hi! I’ve made a small improvement to the README to enhance clarity and usability.

Please let me know if any changes are needed. I’d be happy to update it.

[Udayraj123]

added comment