Skip to content

Commit 39219ca

Browse files
committed
Make the README a bit more user friendly
1 parent bc4fceb commit 39219ca

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -82,15 +82,15 @@ For more see the UltiSnips docs (`:help UltiSnips`).
8282
Installation
8383
------------
8484

85-
First be aware that there are many options, see "Snippet engines" above.
86-
Second be aware than there are [tons of plugin managers](http://vim-wiki.mawercer.de/wiki/topic/vim%20plugin%20managment.html)
87-
which is why Marc Weber thinks that it doesn't make sense to repeat the same
88-
repetitive information everywhere.
85+
First be aware that there are many options, see "Snippet engines" above. Second
86+
be aware than there are [tons of plugin managers][8] which is why Marc Weber
87+
thinks that it doesn't make sense to repeat the same repetitive information
88+
everywhere.
8989

90-
*Recommended way:*
91-
[vim-addon-manager](https://github.com/MarcWeber/vim-addon-manager) (because Marc Weber wrote it for exactly
92-
this reason, it supports simple dependency management). E.g. you're done by this
93-
line in your `.vimrc`:
90+
The recommended way to install these snippets is by using
91+
[vim-addon-manager][9]. Marc Weber wrote it for exactly this reason, it
92+
supports simple dependency management. E.g. all you need is this line in your
93+
`.vimrc`:
9494

9595
```vim
9696
" assuming you want to use snipmate snippet engine
@@ -100,20 +100,18 @@ ActivateAddons vim-snippets snipmate
100100
[vim-pi](https://bitbucket.org/vimcommunity/vim-pi/issue/90/we-really-need-a-web-interface)
101101
Is the place to discuss plugin managers and repository resources.
102102

103-
About how to install snipMate see [snipmate@garbas](https://github.com/garbas/vim-snipmate)
103+
For snipMate installation instructions, please see [snipmate@garbas][1].
104104

105-
(Bundle, Pathogen, git clone - keywords to make people find this link by ctrl-f search)
106-
I know that I should be reading the docs of the snippet engine, just let me copy paste into my `.vimrc`:
107-
[See this pull request](https://github.com/honza/vim-snippets/pull/307/files).
105+
Pull requests adding installation instructions for Pathogen, Bundle, git clone,
106+
etc. are welcome and much appreciated.
108107

109108
Getting help
110109
------------
111110

112-
If you still have trouble getting this to work create a GitHub ticket, ask on
113-
IRC or the mailing list.
111+
If you still have trouble getting this to work, please create a GitHub issue.
114112

115-
Policies / for contributors
116-
---------------------------
113+
Things to consider when contributing
114+
------------------------------------
117115

118116
Some snippets are useful for almost all languages, so let's try to have the same
119117
triggers for them:
@@ -251,3 +249,5 @@ terms of the MIT license.
251249
[3]: http://github.com/garbas
252250
[4]: http://github.com/garbas/vim-snipmate
253251
[7]: http://github.com/SirVer/ultisnips
252+
[8]: http://vim-wiki.mawercer.de/wiki/topic/vim%20plugin%20managment.html
253+
[9]: https://github.com/MarcWeber/vim-addon-manager

0 commit comments

Comments
 (0)