diff options
| author | Ben Linskey | 2016-07-24 16:30:47 -0400 |
|---|---|---|
| committer | Ben Linskey | 2016-07-24 16:42:29 -0400 |
| commit | c4aa65c6fa1fb15716af21f99eb78b32a68a79ab (patch) | |
| tree | dc4eaa381665cdcafe7858b454f6ad3ac548defb | |
| parent | 49280fff3e92242eb116a4ae8fbd92afd2aedc6f (diff) | |
| download | vim-armenian-keymaps-c4aa65c6fa1fb15716af21f99eb78b32a68a79ab.tar.gz | |
Update readme
| -rw-r--r-- | README.md | 25 |
1 files changed, 18 insertions, 7 deletions
@@ -6,18 +6,28 @@ functionality in Normal mode. The `master` branch provides a pair of common mappings for the Western and Eastern dialects that cover the full alphabet and all standard punctuation -marks. The `alt` branch provides an alternate set of mappings based on the -xkeyboard-config Armenian keymaps. +marks. These are included in the [Vim source code][]. The `alt` branch provides +an alternate set of mappings based on the xkeyboard-config Armenian keymaps. Please feel free to submit additional keymaps or corrections as pull requests or patches sent to <vim@benlinskey.com>. ## Setup -Copy or link a keymap file to the directory `/usr/share/vim/vim74/keymap/`, -then enable the keymap in your `.vimrc` using the `keymap` option. +### Installing the keymap files -For example, to use the Western Armenian keymap, copy or link +The keymaps on the `master` branch are included with Vim, so you can skip ahead +to [Activaing a keymap](#activating-a-keymap) if you’re using a newer version +of Vim and you don’t need one of the alternate keymaps from the `alt` branch. + +If the keymap file you want to use isn’t installed on your system, copy or link +the file to your Vim keymap directory (`/usr/share/vim/vim74/keymap` by default +in Vim 7.4). + +### Activating a keymap + +To use a keymap, you’ll need to enable it in your `.vimrc` using the `keymap` +option. For example, to use the Western Armenian keymap, copy or link `armenian-western_utf-8.vim` to the directory `/usr/share/vim/vim74/keymap/`, then enable the keymap in your `.vimrc`: @@ -26,8 +36,8 @@ set keymap=armenian-western_utf-8 ``` You can switch between Armenian and Latin characters in Insert mode using -<kbd>Ctrl-^</kbd>. To disable the keymap at Vim startup, add the following -lines to your `.vimrc`: +<kbd>Ctrl-^</kbd>. To disable the keymap at Vim startup so that Insert mode +uses Latin characters by default, add the following lines to your `.vimrc`: ```vim set iminsert=0 @@ -54,4 +64,5 @@ en.wikipedia to Commons.) [[CC BY-SA 3.0][]], en.wikipedia to Commons.) [[CC BY-SA 3.0][]], [via Wikimedia Commons](https://commons.wikimedia.org/wiki/File%3AKB_Western_Armenian.svg).* +[Vim source code]: https://github.com/vim/vim [CC BY-SA 3.0]: http://creativecommons.org/licenses/by-sa/3.0 |