aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2018-03-26 20:16:12 +0200
committerTeddy Wing2018-03-26 20:16:12 +0200
commit90914d0d2474a78f6a26e62d8d7411ef017f1e88 (patch)
tree9083cc5f7881ff8ce1b09da801ae483bf85b8757
parent60c00a3d5b0f429374854b0a5eb8f49a7c95f66d (diff)
downloadQWAZERTY-90914d0d2474a78f6a26e62d8d7411ef017f1e88.tar.bz2
README: Add a section describing the "emoji" key
Shows they emojis outputted by the key and what key sequences each uses. Move the "Example Usage" section above "Screenshots" because it makes more sense for it to be next to the emoji key section.
-rw-r--r--README.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/README.md b/README.md
index c12316a..c2d3f34 100644
--- a/README.md
+++ b/README.md
@@ -20,7 +20,21 @@ This layout is intended to make ISO keyboards more comfortable to use for
Americans (and those who are accustomed to ANSI QWERTY keyboards).
-## Screenshots
+## The Emoji Key
+ISO keyboards have one more key than ANSI keyboards. QWAZERTY uses this "extra"
+key as a special emoji key. The emojis aren't meant to be used for real, but
+rather as a convenient identifier to rebind the key to any desired function.
+
+Here are the emojis and corresponding key sequences:
+
++--------+----------------------+
+| Output | Key Sequence |
++--------+----------------------+
+| 🕳 | <Emoji> |
+| ⛳ | Shift–<Emoji> |
+| 🌗 | Option–<Emoji> |
+| 🌑 | Shift—Option—<Emoji> |
++--------+----------------------+
## Example Usage
@@ -31,6 +45,9 @@ the special emoji key is pressed:
nnoremap ⛳ :call RunNearestSpec()
+## Screenshots
+
+
## Install
Copy either `QWAZERTY-normal enter key.bundle` or `QWAZERTY.bundle` to
`~/Library/Keyboard Layouts`.