aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBen Linskey2016-05-12 21:46:46 -0400
committerBen Linskey2016-05-12 21:46:46 -0400
commit043e6ec23ab99b3daabf0d3596064b3f30cc75f6 (patch)
treee7f54d77e7229a9ddf5f076b252205e8dffcb78f
parent1baecd2607a2daee449d5d60cfbed9ecc06e88f0 (diff)
downloadvim-armenian-keymaps-043e6ec23ab99b3daabf0d3596064b3f30cc75f6.tar.gz

Update readme

-rw-r--r--README.md25
1 files changed, 16 insertions, 9 deletions
diff --git a/README.md b/README.md
index fcddc78..99584b2 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,17 @@
-# Vim Western Armenian Keymap
+# Vim Armenian Keymaps
-This is a Vim keymap for the Armenian alphabet. It can be used to type Armenian
-characters in Insert mode while retaining standard functionality in Normal
-mode.
-
-This keymap is based on a standard Western Armenian keyboard layout, but it can
-also be used to write Eastern Armenian.
+This is a set of Vim keymaps for the Armenian alphabet. The keymaps can be used
+to type Armenian characters in Insert mode while retaining standard
+functionality in Normal mode.
## Setup
-Copy or link `western-armenian_utf-8.vim` to the directory
-`/usr/share/vim/vim74/keymap/`, then enable the keymap in your `.vimrc`:
+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.
+
+For example, to use the Western Armenian keymap, copy or link
+`western-armenian_utf-8.vim` to the directory `/usr/share/vim/vim74/keymap/`,
+then enable the keymap in your `.vimrc`:
```vim
set keymap=western-armenian_utf-8
@@ -26,3 +27,9 @@ set imsearch=0
```
For more information on keymaps, see `:help mbyte-keymap`.
+
+## To Do
+
+- Armenian (phonetic)
+- Armenian (alternative phonetic)
+- Armenian (alternative eastern)