Permalink
Browse files

I got a message that the README.md does still not tell what VAM is, a…

…dding this information.
  • Loading branch information...
MarcWeber committed Nov 16, 2012
1 parent 886e5c7 commit 491cdc053676940ea19a3b655c15dd009ef97b37
Showing with 16 additions and 6 deletions.
  1. +16 −6 README.md
View
@@ -1,5 +1,20 @@
# VAM — maximizing overall Vim experience
-“VAM” is short name for vim-addon-manager
+“VAM” is short name for vim-addon-manager.
+You declare a set of plugins. VAM will fetch & activate them at startup or
+runtime depending on your needs. Activating means handling runtimepath and
+making sure all .vim file get sourced.
+
+## MINIMAL setup (2 lines)
+
+ set runtimepath+=/path/to/vam
+ call vam#ActivateAddons([list of addon names])
+
+Keep reading to get an overview about VAM.
+
+## NEED MORE INFO?
+
+Skim this README.md file, look at the documentation at doc/ which will tell you
+how to contact us.
## FEATURES
- Declarative: The behaviour of Vim is determined by your .vimrc only. [1]
@@ -50,11 +65,6 @@ Pool is made up of
VAM is well supported by at least 2 maintainers. Try github tickets or Vim irc
channel on freenode.
-## MINIMAL setup (2 lines)
-
- set runtimepath+=/path/to/vam
- call vam#ActivateAddons([list of addon names])
-
However the “self install” alternative is recommended, see
[section 2 of GETTING STARTED](https://raw.github.com/MarcWeber/vim-addon-manager/master/doc/vim-addon-manager-getting-started.txt)

0 comments on commit 491cdc0

Please sign in to comment.