Skip to content

Commit

Permalink
Use the composition symbol in the documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
samhocevar committed Apr 24, 2014
1 parent 8996b18 commit 677738f
Showing 1 changed file with 18 additions and 17 deletions.
35 changes: 18 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@ Quick start
-----------

After installation, WinCompose should appear in the System Tray. Press and
release the <kbd>Right Alt</kbd> key to initiate a compose sequence; the icon
should change to indicate a compose sequence is in progress.
release the <kbd>⎄ Compose</kbd> key to initiate a compose sequence (this key
defaults to <kbd>Right Alt</kbd>); the icon should change to indicate a compose
sequence is in progress.

Then type in the keys for a compose sequence, such as <kbd>A</kbd> then
<kbd>E</kbd> for **Æ**:
Expand All @@ -33,18 +34,18 @@ Examples

Compose rules are supposed to be intuitive. Here are some examples:

- <kbd>\`</kbd> <kbd>a</kbd> → **à**
- <kbd>'</kbd> <kbd>e</kbd> → **é**
- <kbd>^</kbd> <kbd>i</kbd> → **î**
- <kbd>~</kbd> <kbd>n</kbd> → **ñ**
- <kbd>/</kbd> <kbd>o</kbd> → **ø**
- <kbd>"</kbd> <kbd>u</kbd> → **ü**
- <kbd>o</kbd> <kbd>c</kbd> → **©**
- <kbd>+</kbd> <kbd>-</kbd> → **±**
- <kbd>:</kbd> <kbd>-</kbd> → **÷**
- <kbd>(</kbd> <kbd>7</kbd> <kbd>)</kbd> → ****
- <kbd>C</kbd> <kbd>C</kbd> <kbd>C</kbd> <kbd>P</kbd> → ****
- <kbd>&lt;</kbd> <kbd>3</kbd> → ****
- <kbd>⎄ Compose</kbd> <kbd>\`</kbd> <kbd>a</kbd> → **à**
- <kbd>⎄ Compose</kbd> <kbd>'</kbd> <kbd>e</kbd> → **é**
- <kbd>⎄ Compose</kbd> <kbd>^</kbd> <kbd>i</kbd> → **î**
- <kbd>⎄ Compose</kbd> <kbd>~</kbd> <kbd>n</kbd> → **ñ**
- <kbd>⎄ Compose</kbd> <kbd>/</kbd> <kbd>o</kbd> → **ø**
- <kbd>⎄ Compose</kbd> <kbd>"</kbd> <kbd>u</kbd> → **ü**
- <kbd>⎄ Compose</kbd> <kbd>o</kbd> <kbd>c</kbd> → **©**
- <kbd>⎄ Compose</kbd> <kbd>+</kbd> <kbd>-</kbd> → **±**
- <kbd>⎄ Compose</kbd> <kbd>:</kbd> <kbd>-</kbd> → **÷**
- <kbd>⎄ Compose</kbd> <kbd>(</kbd> <kbd>7</kbd> <kbd>)</kbd> → ****
- <kbd>⎄ Compose</kbd> <kbd>C</kbd> <kbd>C</kbd> <kbd>C</kbd> <kbd>P</kbd> → ****
- <kbd>⎄ Compose</kbd> <kbd>&lt;</kbd> <kbd>3</kbd> → ****

The full list of rules can be found by clicking on the WinCompose system tray
icon or using the “Show Sequences…” menu entry:
Expand All @@ -62,10 +63,10 @@ WinCompose supports the standard Compose file format. It provides more than
rules by creating a file named `.XCompose` or `.XCompose.txt` in your
`%USERPROFILE%` directory.

WinCompose supports rules of more than 2 characters such as <kbd>(</kbd> <kbd>3</kbd> <kbd>)</kbd>
for ****.
WinCompose supports rules of more than 2 characters such as <kbd>⎄ Compose</kbd>
<kbd>(</kbd> <kbd>3</kbd> <kbd>)</kbd> for ****.

WinCompose supports early exits. For instance, <kbd>Compose</kbd> <kbd>&</kbd> will
WinCompose supports early exits. For instance, <kbd>Compose</kbd> <kbd>&</kbd> will
immediately type **&** because there is currently no rule starting with <kbd>&</kbd>.

WinCompose does not emit unnecessary keystrokes, such as a backspace keystroke
Expand Down

0 comments on commit 677738f

Please sign in to comment.