Tidy up the README
- ID
f5627dd- date
2024-06-06 06:45:53+00:00- author
Alex Chan <alex@alexwlchan.net>- parent
ce05b0d- message
Tidy up the README- changed files
2 files, 18 additions, 2 deletions
Changed files
README.md (1493) → README.md (2531)
diff --git a/README.md b/README.md
index 41304d2..4fe9ddf 100644
--- a/README.md
+++ b/README.md
@@ -4,11 +4,27 @@ This tool uses Apple’s [Live Text feature](https://support.apple.com/en-gb/gui
This gives you a way to OCR images programatically without installing any extra software.
```console
-$ get_live_text "picture_of_a_sign.jpg"
+$ get_live_text "railway_sign.jpg"
```
This is the same as if you'd copy/pasted the text from the image using the Preview app, but now you can do so programatically and in bulk.
+<img src="railway_sign.jpg" alt="A picture of a railway sign with the text highlighted, and a popover menu offering several options: ‘Look up “Passengers must not pass this point or cross the line”’, ‘Translate “Passengers must not pass this point or cross the line”’, Search with Google, Copy, or Share.">
+
+## Motivation
+
+My priority is convenience, not absolute accuracy.
+
+I've had issues installing third-party OCR tools in the past, whereas Live Text is built into macOS.
+It's pretty quick for me to get this up and running on a new machine.
+
+There may be other frameworks which provide more accurate transcription of text, but Live Text is good enough for my purposes.
+Currently I have two use cases for this script:
+
+* Transcribing screenshots from my ebook reader, to add to my notes app.
+ I go through and edit those transcripts, so I can fix any mistakes it’s made.
+* Creating search indexes of scanned images, where a little bit of inaccuracy is fine, as long as it's good enough for me to find the right image.
+
## Installation
### Install from source
@@ -38,5 +54,5 @@ You can get around this by right-clicking the app icon in Finder, and choosing `
Run the script passing one arguments: the path to the image you want to OCR.
```console
-$ get_live_text "picture_of_a_sign.jpg"
+$ get_live_text "railway_sign.jpg"
```
railway_sign.jpg (0) → railway_sign.jpg (313743)
diff --git a/railway_sign.jpg b/railway_sign.jpg
new file mode 100644
index 0000000..e304eab
Binary files /dev/null and b/railway_sign.jpg differ