Skip to content

Commit c0e71b2

Browse files
committed
Add codespell CI and document Homebrew path in Shortcut setup
Credits: - codespell config and workflow adapted from #37 by @yarikoptic - Homebrew path documentation from #34 by @benwinding
1 parent 7eac7a0 commit c0e71b2

3 files changed

Lines changed: 33 additions & 1 deletion

File tree

.codespellrc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[codespell]
2+
# Ref: https://github.com/codespell-project/codespell#using-a-config-file
3+
skip = .git*,*.lock,.codespellrc,Pods
4+
check-hidden = true
5+
ignore-words-list = inout

.github/workflows/codespell.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Codespell configuration is within .codespellrc
2+
---
3+
name: Codespell
4+
5+
on:
6+
push:
7+
branches: [master]
8+
pull_request:
9+
branches: [master]
10+
11+
permissions:
12+
contents: read
13+
14+
jobs:
15+
codespell:
16+
name: Check for spelling errors
17+
runs-on: ubuntu-latest
18+
19+
steps:
20+
- name: Checkout
21+
uses: actions/checkout@v4
22+
- name: Annotate locations with typos
23+
uses: codespell-project/codespell-problem-matcher@v1
24+
- name: Codespell
25+
uses: codespell-project/actions-codespell@v2

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,9 @@ Run `ocr --list-languages` to see all available languages on your system.
130130
1. Open up [MacOS Shortcuts](https://www.icloud.com/shortcuts/fa91687e481849d6a27ff873ec71599b) available on MacOS 12+.
131131
2. Create new `Shortcut`
132132
3. Add `Run Shell script`
133-
4. Set input as `/usr/local/bin/ocr` (runs this app)
133+
4. Set input to one of these (runs this app):
134+
- `/opt/homebrew/bin/ocr` (if installed via Homebrew on Apple Silicon)
135+
- `/usr/local/bin/ocr` (if installed manually or via Homebrew on Intel)
134136
5. Goto `Shortcut Details`
135137

136138
<img width="300px" src="https://user-images.githubusercontent.com/11782590/164676495-3c07a73f-5254-47eb-a4ff-d6a943617954.png" alt="settings" />

0 commit comments

Comments
 (0)