Skip to content

Commit aef38ac

Browse files
committed
Update README and .gitignore; add QR code decoding details and ignore .vscode directory
1 parent c0cd5c1 commit aef38ac

3 files changed

Lines changed: 11 additions & 13 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,4 @@ spectacle-ocr-screenshot
5151

5252
# .nfs files are created when an open file is removed but is still being accessed
5353
.nfs*
54+
.vscode

README.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# Spectacle OCR Screenshot
22

3-
A simple Qt application that integrates KDE Spectacle screenshot tool with Tesseract OCR to extract text from screenshots.
3+
A simple Qt application that integrates KDE Spectacle screenshot tool with Tesseract OCR to extract text from screenshots as well QR codes.
44

55
![Screenshot](screenshot.png)
66

77
## Features
88

99
- Capture screenshots using KDE's Spectacle tool
1010
- Extract text from screenshots using Tesseract OCR
11+
- Decode QR codes from screenshots
12+
- Display extracted text in a user-friendly interface
1113
- Support for multiple languages
1214
- Edit extracted text before saving
1315
- Copy text to clipboard
@@ -20,6 +22,7 @@ A simple Qt application that integrates KDE Spectacle screenshot tool with Tesse
2022
- Tesseract OCR
2123
- Leptonica
2224
- KDE Spectacle
25+
- Zxing (for QR code decoding)
2326

2427
## Installation
2528

@@ -99,7 +102,9 @@ Then you can run the application from anywhere using or by assigning a keyboard
99102
- Use ISO 639-3 language codes
100103
- For multiple languages, join them with '+' (e.g., `--lang eng+hin` for English and Hindi)
101104

102-
Examples:
105+
- `--disable-qr`: Disable QR code detection
106+
107+
#### Examples:
103108
```bash
104109
# Use English OCR (default)
105110
./spectacle-ocr-screenshot
@@ -117,19 +122,11 @@ Tesseract OCR supports many languages. Some common language codes:
117122

118123
- `eng` - English
119124
- `deu` - German
120-
- `fra` - French
121-
- `spa` - Spanish
122-
- `ita` - Italian
123-
- `rus` - Russian
124-
- `jpn` - Japanese
125-
- `kor` - Korean
126-
- `chi_sim` - Chinese (Simplified)
127-
- `chi_tra` - Chinese (Traditional)
128-
- `ara` - Arabic
129125
- `hin` - Hindi
130126

131-
You may need to install language packs for Tesseract OCR separately.
127+
> [!NOTE]
128+
>You may need to install language packs for Tesseract OCR separately.
132129
133130
## License
134131

135-
[MIT](https://github.com/funinkina/spectacle-ocr-screenshot/blob/main/LICENSE)
132+
[MIT](LICENSE)

screenshot.png

100755100644
164 KB
Loading

0 commit comments

Comments
 (0)