Skip to content

Commit

Permalink
Replace references to knausj_talon with community.
Browse files Browse the repository at this point in the history
  • Loading branch information
wolfmanstout committed Feb 3, 2024
1 parent e4d67b6 commit e0cdf87
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ for an overview.
## Installation

`git clone` this repo into your Talon user scripts folder. Requires
[knausj_talon](https://github.com/knausj85/knausj_talon) to be installed as a
[community](https://github.com/talonhub/community) to be installed as a
sibling in the same directory.

Required permissions:
Expand Down Expand Up @@ -39,17 +39,19 @@ working using Tesseract, but this configuration is not tested by the author.
- Applies fuzzy matching to one or more spoken words.
- Works with or without an eye tracker (just expect slower processing and more
disambiguation).
- Matches homophones of recognized words (based on CSV in knausj). Also matches
numbers and punctuation in either their spoken form (e.g. "two" and "period")
or their symbolic form (e.g. "2" and ".").
- Matches homophones of recognized words (based on CSV in
- [community](https://github.com/talonhub/community)). Also
matches numbers and punctuation in either their spoken form (e.g. "two" and
"period") or their symbolic form (e.g. "2" and ".").
- Briefly displays debugging overlay if no matches are present.

## Known limitations:

- Only operates on the main screen, as defined by Talon.
- Updates (via git pull) and some settings changes require Talon restart.
- Numbers must be referred to by their individual digits.
- Modifications to punctuation and digit names in knausj not leveraged.
- Modifications to punctuation and digit names in
[community](https://github.com/talonhub/community) not leveraged.
- Depends on OS-provided text recognition (OCR), which is not perfectly accurate.
- Cursor positioning often imprecise around text with underline, strikethrough,
or squiggly.
Expand All @@ -76,10 +78,10 @@ To contribute, changes can be pushed and pulled to all repositories using
`gaze-ocr`, `rapidfuzz`, and `jarowinkler` are all configured as git remotes,
and `git subtree` is available.

## Running without knausj_talon
## Running without `community`

As noted in the installation instructions,
[knausj_talon](https://github.com/knausj85/knausj_talon) is highly recommended,
[community](https://github.com/talonhub/community) is highly recommended,
but most functionality will still be available in degraded form without it (and
you will see some warning logs). Missing functionality:

Expand Down

0 comments on commit e0cdf87

Please sign in to comment.