You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+32-46Lines changed: 32 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,9 @@
16
16
17
17
</div>
18
18
19
+
> [!NOTE]
20
+
> This is a personal project maintained on a best-effort basis. PRs are more likely to be reviewed than feature requests or issues, unless I am facing the same problem.
21
+
19
22
## ✨ Features
20
23
21
24
- 🎯 **Hint Mode** - Click any UI element using keyboard shortcuts
4. Choose the action to perform (e.g., "left click", "right click", "double click", "middle click")
74
+
5. Press `Esc` to exit
75
+
65
76
### Scroll Mode
66
77
67
78
1. Press `Cmd+Shift+J` (default)
@@ -136,10 +147,6 @@ For app-specific settings, find the bundle ID using:
136
147
osascript -e 'id of app "App Name"'
137
148
```
138
149
139
-
## 🤝 Contributing
140
-
141
-
See `configs/default-config.toml` for all available options.
142
-
143
150
### Per-App Role Configuration
144
151
145
152
GoVim supports global and per-app accessibility role configurations:
@@ -154,13 +161,12 @@ To find an app's bundle ID:
154
161
osascript -e 'id of app "AppName"'
155
162
```
156
163
157
-
Example per-app configuration:
164
+
For example, in `Mail.app`, lots of element are `AXStaticText` and they should be clickable. In this case, we don't want to add to the global one, as it will causes lots of unclickable hints, especially in browser space.
158
165
159
166
```toml
160
167
[[accessibility.app_configs]]
161
-
bundle_id = "com.microsoft.VSCode"
168
+
bundle_id = "com.apple.mail"
162
169
additional_clickable_roles = ["AXStaticText"]
163
-
additional_scrollable_roles = ["AXGroup"]
164
170
```
165
171
166
172
### Electron & Chrome Support
@@ -220,35 +226,6 @@ govim hints_action
220
226
govim scroll
221
227
```
222
228
223
-
#### Electron Apps Support
224
-
225
-
GoVim includes special support for Electron-based applications like VS Code and Chrome, with:
226
-
227
-
- Optimized element detection
228
-
- Improved scrolling behavior
229
-
- Better hint placement
230
-
231
-
## 🤝 Contributing
232
-
233
-
Contributions welcome! Here's how:
234
-
235
-
1. Fork the repository
236
-
2. Create a feature branch
237
-
3. Make your changes
238
-
4. Run `just test` and `just lint` to verify
239
-
5. Submit a pull request
240
-
241
-
## 📝 License
242
-
243
-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
244
-
245
-
---
246
-
247
-
<divalign="center">
248
-
Made with ❤️ by <ahref="https://github.com/y3owk1n">y3owk1n</a>
249
-
</div>
250
-
```
251
-
252
229
### Examples
253
230
254
231
```bash
@@ -320,14 +297,6 @@ govim/
320
297
└── scripts/ # Build and packaging scripts
321
298
```
322
299
323
-
## Performance
324
-
325
-
- Hint generation: <100ms for typical windows
326
-
- UI element detection: <50ms
327
-
- Hotkey response: <10ms
328
-
- Idle CPU usage: <1%
329
-
- Memory usage: <50MB typical
330
-
331
300
## Troubleshooting
332
301
333
302
### Accessibility Permissions
@@ -434,7 +403,7 @@ just test-race # Race detection
434
403
435
404
## License
436
405
437
-
MIT License - see LICENSE file for details
406
+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
438
407
439
408
## Acknowledgments
440
409
@@ -444,3 +413,20 @@ Inspired by:
444
413
-[Vimac](https://github.com/dexterleng/vimac)
445
414
-[Shortcat](https://shortcat.app/)
446
415
-[Vimium](https://github.com/philc/vimium)
416
+
417
+
## 🤝 Contributing
418
+
419
+
Contributions welcome! Here's how:
420
+
421
+
1. Fork the repository
422
+
2. Create a feature branch
423
+
3. Make your changes
424
+
4. Run `just test` and `just lint` to verify
425
+
5. Submit a pull request
426
+
427
+
---
428
+
429
+
<divalign="center">
430
+
Made with ❤️ by <ahref="https://github.com/y3owk1n">y3owk1n</a>
0 commit comments