From eafcff41ceff1892d627a14c439f923018042196 Mon Sep 17 00:00:00 2001 From: Luke Plant Date: Wed, 14 Dec 2016 13:26:44 +0200 Subject: Added some usage instructions. --- README.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 248f44d..b60aa00 100644 --- a/README.md +++ b/README.md @@ -12,3 +12,7 @@ broadly acceptable set of keybindings that won't interfere with the traditional Compose bindings, aren't too hard to type, and cover a wide set of characters that are useful to use occasionally, making them available without the need for specialized input methods. + +After installing `.XCompose` you will need to restart any applications +to see its effect for that application. Not all applications support +XCompose, and it depends on which input method you are using. -- cgit v1.2.3 From cb2c1de020291bef82e69bd5bd19da40401ada03 Mon Sep 17 00:00:00 2001 From: Mark Shoulson Date: Mon, 3 Apr 2017 09:28:15 -0400 Subject: README explains how to include files. Removed modletters.compose and emoji.compose from repo, since they're generated by make. SALTILLO was already in dotXCompose; removed from modletters and added lowercase to dotXCompose. Added GREEK QUESTION MARK, because I'm a horrible person. --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index b60aa00..ca87563 100644 --- a/README.md +++ b/README.md @@ -16,3 +16,22 @@ them available without the need for specialized input methods. After installing `.XCompose` you will need to restart any applications to see its effect for that application. Not all applications support XCompose, and it depends on which input method you are using. + +Some "extensions" have been added to this repository, and installing them +may take a few more commands. Use `make` to generate the extension files +(for emoji, modifier letters, etc.) You can include them by using the +`include` directive in your `.XCompose` file. So you might actually not +want to use our `install` script, but rather create your own `.XCompose` +(perhaps with your own personal entries) along these lines: + + include "/path/to/dotXCompose" + include "/path/to/frakturcompose" + include "/path/to/emoji.compose" + include "/path/to/modletters.compose" + include "/path/to/parens.compose" + + # I complain a lot, oy... + : "ѹ" U0479 # CYRILLIC SMALL LETTER UK + # My very original smileyface! + : "㋡" U32E1 # CIRCLED KATAKANA TU + # ... -- cgit v1.2.3