Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix instructions, improve flow #21

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix instructions, improve flow #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@ Features
- [x] tiny disk size (under 3mb)
- [x] easy on the ram (under 50mb)

## Troubleshooting

After upgrading (or rebuilding locally), be sure to go to Security & Privacy > Privacy > Accessibility and re-authorize qmoji! uncheck & check the box, otherwise it won't be able to send characters to other applications.

![screenshot](screenshot.png)
![screenshot 2](screenshot2.png)

Expand All @@ -25,22 +21,29 @@ Inspired by the excellent [mojibar](https://github.com/muan/mojibar).
- go to [the releases page](https://github.com/jaredly/qmoji/releases)
- download `qmoji.zip` & unzip it
- right-click qmoji.app & select "open" (because it's not signed, double-clicking won't work the first time)
- you should see a 🙃 in your statusbar
- if you want to use the default shortcut (cmd+opt+space), you'll need to disable the macos "show a finder search window" shortcut like so https://twitter.com/ThomasAlcala/status/1088710623708565504
- you should see a 🙃 in your menu bar
- go to Security & Privacy > Privacy > Accessibility and allow qmoji
- if you want to use the default shortcut (cmd+opt+space), you'll need to disable the macos "Show Finder search window" shortcut like so https://apple.stackexchange.com/a/105561/36202
- go forth and emoji ⚡ 🏎

## Controls

Keyboard:
- trigger with option-cmd-space

- trigger with option-cmd-space (remap with the options button at top right > Change shortcut key)
- tab & shift-tab or arrow keys to move the selection
- enter to use the current emoji (it types it into the topmost application for you)
- escape to clear the search text, or if it's empty then it closes the window

Mouse:

- click an emoji to select it
- right-click an emoji to remove from "recently used" list

## Troubleshooting

After upgrading (or rebuilding locally), be sure to go to Security & Privacy > Privacy > Accessibility and re-authorize qmoji! uncheck & check the box, otherwise it won't be able to send characters to other applications.<br><br>

## Contributing

- Xcode, it should build & run without any issues (no third-party libraries used)