Skip to content

Commit 9c89dd5

Browse files
committed
Add README.md file
1 parent 07ac6a9 commit 9c89dd5

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# OCRit
2+
3+
OCR it on macOS with DeepSeek-OCR.
4+
5+
OCRit is a small macOS utility written in Swift that uses DeepSeek-OCR to recognize text from the screen and make it available for copying, searching, or further processing. It's designed to be lightweight and simple to use.
6+
7+
## Features
8+
- Capture a region of the screen and run OCR on it
9+
- Fast local OCR using DeepSeek-OCR integration
10+
- Copy recognized text to the clipboard
11+
- Simple macOS-native UI written in Swift
12+
13+
## Requirements
14+
- macOS 11.0+ (Big Sur or later)
15+
- Xcode 13 or newer for building from source
16+
- (Optional) Any required model files or dependencies for DeepSeek-OCR — see project code for details
17+
18+
## Building from source
19+
1. Clone the repository:
20+
21+
git clone https://github.com/aeilot/OCRit.git
22+
2. Open OCRit.xcodeproj (or OCRit.xcworkspace if using CocoaPods/Carthage/SwiftPM resources) in Xcode.
23+
3. Select a macOS target and a valid signing team in the project settings.
24+
4. Build and run (Cmd+R).
25+
26+
## Usage
27+
1. Launch the app.
28+
2. Grant any requested permissions (Screen Recording and Accessibility) so the app can capture and interact with the screen.
29+
3. Use the app UI to select a region or capture the current screen.
30+
4. Wait briefly while OCR runs; the recognized text will appear and you can copy it to the clipboard.
31+
32+
## Configuration
33+
- If DeepSeek-OCR requires model files or additional configuration, place them according to the instructions in the source files or the project's configuration section.
34+
35+
## Contributing
36+
Contributions and bug reports are welcome. If you'd like to contribute:
37+
1. Open an issue describing the problem or feature.
38+
2. Fork the repo and create a branch for your change.
39+
3. Open a pull request describing your changes.
40+
41+
## Acknowledgements
42+
- DeepSeek-OCR — thank you to the authors/contributors of the OCR model and tooling.
43+
44+
## License
45+
No license file is included in this repository. If you'd like a specific license (for example, MIT), add a LICENSE file or tell me which license you prefer and I can add one.
46+
47+
## Contact
48+
If you have questions or need help, open an issue on the repository: https://github.com/aeilot/OCRit/issues
49+
50+
---
51+
52+
This README was added by GitHub Copilot on request of the repository owner.

0 commit comments

Comments
 (0)