Awesome
<p align="center"> <a href="" rel="noopener"> <img width=100px height=100px src="doc/logo_doc.png" alt="Project logo"> </a> </p> <h2 align="center">Cloe</h2> <p align="center"> Snipping utility for the MangaOCR model </p>Contents
- About
- User Guide
- Acknowledgments </br></br>
About <a name = "about"></a>
Inspired by Capture2Text, Cloe is a snipping tool for the Manga OCR library. The project works similarly to Capture2Text but uses the MangaOCR model instead. See demo below to see how it works.
User Guide <a name="user_guide"></a>
Launch the application and wait for the model to load. Show the snipping window using shortcut Alt+Q
and drag and hold the mouse cursor to start performing OCR.
Installation <a name = "installation"></a>
Download the latest zip file here. Decompress the file in the desired directory. Make sure that the app
folder is in the same folder as the shortcut Cloe
.
System Requirements
Recommended:
- Hard drive: at least 700 MB HD space
- RAM: at least 2 GB (recommended)
Development Setup
- Install poetry on a supported Python version (3.8, 3.9).
- Clone this repo and install dependencies by running:
poetry install --with dev
. - In the
app
directory, usepython main.py
to run the app. - If you want to build the app locally, run
pyinstaller main.spec
in thebuild
directory.
Acknowledgements <a name = "acknowledgements"></a>
This project will not be possible without the MangaOCR model by Maciej Budyś.
The software is licensed under GPLv3 (see LICENSE) and uses third party libraries that are distributed under their own terms (see LICENSE-3RD-PARTY).
The icons used in this project are from Icons8.