Skip to content

docs: clarify OCR setup and contribution workflow #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SimpleCaci merged 2 commits into from
Nov 7, 2026
Merged

docs: clarify OCR setup and contribution workflow #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c43f6fe
style: satisfy current Ruff checks
SimpleCaci Nov 7, 2026
40ab67c
docs: clarify OCR setup and contribution workflow
SimpleCaci Nov 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Contributing to HandwritingConverter

Use Python 3.11+ and the Tesseract installation described in the README. Install `requirements-dev.txt` in a virtual environment, then run:

```bash
ruff check main.py tests
python -m pytest -q
```

The deterministic tests replace the OCR call while exercising image preparation, reports, and file output. Changes to recognition behavior should also include a local Tesseract run and identify the language data and page-segmentation mode used.

Keep sample notes synthetic or yours to share. Do not attach private class notes or someone else's handwriting without permission. For an OCR bug, describe lighting, image orientation, Tesseract version, command options, and expected versus observed text. Confidence scores are not accuracy measurements.

For a pull request, explain the change and validation. Include a report screenshot for presentation changes, and preserve the distinction between raw OCR and manually reviewed text. Discuss a new OCR backend or desktop interface in an issue before adding large dependencies.

Contributions follow the existing MIT license. There is no guaranteed support or response time.
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Turn photos of handwritten notes into searchable text and a printable PDF.

[![Checks](https://github.com/SimpleCaci/HandwritingConverter/actions/workflows/validate.yml/badge.svg)](https://github.com/SimpleCaci/HandwritingConverter/actions/workflows/validate.yml)

[Install](#installation) · [Convert notes](#usage) · [Contribute](CONTRIBUTING.md)

![HandwritingConverter before and after](docs/media/hero.png)

I built this because writing by hand is often the fastest way for me to think, but paper notes are difficult to search, revise, and print with my portable printer. HandwritingConverter connects those two workflows without pretending that handwriting OCR is perfect.
Expand Down
Loading
Loading