vim: improve docs for vim plugin
No change to logic, docs change only.
This adds clearer docs for how to install the vim plugin. Now that it's
moved out of chromium, it's easy to let modern vim plugin managers
manage the GN repo and load the plugin from within.
I'm personally a vim-plug user, and thought others might benefit from
including install steps using that. I included Vundle instructions since
the API should be the same (although I haven't personally tested this).
This also moves from README.chromium to README.md for nicer markdown
rendering.
Test: manual - I regularly use the vim-plug config without issue.
Change-Id: Id9d388f1619577bb4e765bd5570f1e30f9d27f70
Reviewed-on: https://gn-review.googlesource.com/2840
Reviewed-by: Scott Graham <scottmg@chromium.org>
Commit-Queue: Scott Graham <scottmg@chromium.org>
diff --git a/tools/gn/misc/vim/README.chromium b/tools/gn/misc/vim/README.chromium
deleted file mode 100644
index 7b73cfc..0000000
--- a/tools/gn/misc/vim/README.chromium
+++ /dev/null
@@ -1,5 +0,0 @@
-You can use this by adding
-
- set runtimepath+=/path/to/src/tools/gn/misc/vim
-
-to your .vimrc.
diff --git a/tools/gn/misc/vim/README.md b/tools/gn/misc/vim/README.md
new file mode 100644
index 0000000..f64e22a
--- /dev/null
+++ b/tools/gn/misc/vim/README.md
@@ -0,0 +1,29 @@
+# GN vim syntax plugin
+
+## Installation with a plugin manager
+
+You can use modern plugin managers to download the GN repo and manage the vim
+plugin:
+
+Example config for [vim-plug](https://github.com/junegunn/vim-plug):
+
+```
+Plug 'https://gn.googlesource.com/gn', { 'rtp': 'tools/gn/misc/vim' }
+```
+
+Or, for [Vundle](https://github.com/VundleVim/Vundle.vim) users:
+
+```
+Plugin 'https://gn.googlesource.com/gn', { 'rtp': 'tools/gn/misc/vim' }
+```
+
+## Manual installation
+
+If you don't use a plugin manager or would prefer to manage the GN repo
+yourself, you can add this explicitly to `rtp` in your `.vimrc`:
+
+```
+set runtimepath+=/path/to/src/tools/gn/misc/vim
+" ...
+filetype plugin indent on " or a similar command to turn on filetypes in vim
+```
