Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Improved documentation

  • Loading branch information...
commit 9219df89f0b23e9ed20e1b5188f562bb91e85139 1 parent b9aadb9
@ZyX-I ZyX-I authored
Showing with 56 additions and 48 deletions.
  1. +48 −40 README.md
  2. +8 −8 doc/vim-addon-manager-getting-started.txt
View
88 README.md
@@ -1,42 +1,50 @@
-## VAM - maximizing overall Vim experience
-[VAM] is short name for vim-addon-manager
+# VAM maximizing overall Vim experience
+VAM is short name for vim-addon-manager
## FEATURES
-- declarative: The behaviour of Vim is determined by your .vimrc only [1]
-- automatic runtimepath handling:
- install/ update/ use manually installed plugin on startup or load them lazily
- as needed when you feel that way [3]
-- dependency management builtin [2]
-- based on a "[pool](http://mawercer.de/~marc/vam/index.php)" of plugin which
- is maintained by the community.
- This allows warning you if you're going to install outdated packages.
- Of course you can opt-out and use your own pool easily.
-- sources from www.vim.org, git, mercurial, svn, darcs, cvs, bazaar, [...]
-- plugin name completion in .vim files and :(Update|Activate)Addons commands
-- short syntax for github repos: "github:name/repo"
-- optionally writes update logs
-- cares about [windows users](http://mawercer.de/~marc/vam/index.php)
-- plugin info by name or script id (:AddonInfo)
-- tries to preserve user modifications by using diff/patch tools on unix like
- environments
-- 100% VimL (is this really that good ? ..)
+- Declarative: The behaviour of Vim is determined by your .vimrc only. [1]
+- Automatic runtimepath handling: install/ update/ use manually installed addons
+ on startup or load them lazily as needed when you feel that way. [3]
+- Builtin dependency management. [2]
+- Based on a [pool](http://mawercer.de/~marc/vam/index.php) of addons which is
+ maintained by the community. This allows warning you if you’re going to
+ install outdated packages. Of course you can opt-out and use your own pool
+ easily.
+- Sources from www.vim.org, git, mercurial, subversion, bazaar, darcs, [...]
+- Addon name completion in .vim files and :(Update|Activate)Addons commands.
+- Short syntax for github repos: `github:name/repo`.
+- Optionally writes update logs.
+- Cares about [windows users](http://mawercer.de/~marc/vam/index.php).
+- Addon info by name or script id (:AddonInfo).
+- Tries to preserve user modifications by using diff/patch tools on unix like
+ environments (for non-version-controlled sources).
+- 100 % VimL (is this really that good?..)
[1]: assuming you always use latest versions
-[2]: this serves the community by making it easy to reuse other's code.
- Implemented by a addon-info.json file
-[3]: Yes - there are some special cases where it does not work correctly
- because some au commands don't get triggered
+
+[2]: this serves the community by making it easy to reuse other’s code.
+ Implemented by a addon-info.json file and patchinfo database for addons
+ without VAM support.
+
+[3]: Yes — there are some special cases where it does not work correctly because
+ some autocommands don’t get triggered
## THE POOL
-is made up of
-- [vim.org sources](https://raw.github.com/MarcWeber/vim-addon-manager-known-repositories/master/db/vimorgsources.json) found on [www.vim.org](http://www.vim.org)
- These are update periodically
-- manually added [version controlled sources](https://raw.github.com/MarcWeber/vim-addon-manager-known-repositories/master/db/scmsources.vim)
-- a [patch
- file](https://github.com/MarcWeber/vim-addon-manager-known-repositories/blob/master/db/patchinfo.vim)
- augmenting www.vim.org sources. Eg not all plugins on www.vim.org have correct
- "type" - thus additional information is required to move single files to the
- correct location
+Poll is made up of
+
+- [Plugins found on
+ www.vim.org](https://raw.github.com/MarcWeber/vim-addon-manager-known-repositories/master/db/vimorgsources.json).
+ List is updated by a cron job.
+- [Version controlled and non-www.vim.org
+ sources](https://raw.github.com/MarcWeber/vim-addon-manager-known-repositories/master/db/scmsources.vim).
+ They are added manually, you can file a pull request if you want to add one.
+- [File with additional
+ information](https://github.com/MarcWeber/vim-addon-manager-known-repositories/blob/master/db/patchinfo.vim)
+ augmenting sources: it has information with dependencies [4], corrects addon
+ types and contains deprecations.
+
+[4]: Plugin authors should use addon-info file instead. patchinfo.vim is for
+ addons not supporting VAM.
## SUPPORT
VAM is well supported by at least 2 maintainers. Try github tickets or Vim irc
@@ -45,9 +53,9 @@ channel on freenode.
## MINIMAL setup (2 lines)
set runtimepath+=/path/to/vam
- call vam#ActivateAddons([list of plugin names])
+ call vam#ActivateAddons([list of addon names])
-However the "self install" alternative is recommended, see
+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)
## Let me see all docs!
@@ -60,20 +68,20 @@ Here you go:
See contact information in GETTING STARTED documentation.
## BUGS
-It'll never have nice install progress bars - because the "progress" is not
-very well known because plugins can be installed at any time - and additionall
+Itll never have nice install progress bars because the progress is not
+very well known because addons can be installed at any time and additionall
depnedncies may be encountered.
If you want to be able to rollback you have to use git submodules yourself or
-find a different solution - because VAM also supports other VCS and installing
+find a different solution because VAM also supports other VCS and installing
by .zip,.tar.gz etc
-## related work
+## Related work
Also very famous:
- [vundle](https://github.com/gmarik/vundle)
- [pathogen](https://github.com/tpope/vim-pathogen)
- [vim-scripts](http://vim-scripts.org)
-[debian's vim plugin manager](http://packages.debian.org/sid/vim-addon-manager)
+[debians vim plugin manager](http://packages.debian.org/sid/vim-addon-manager)
The author (Jamessan) is fine with this project sharing the same name.
View
16 doc/vim-addon-manager-getting-started.txt
@@ -57,16 +57,14 @@ WHY VAM?: ~
1. Intro *VAM-intro*
VAM is a shortcut for vim-addon-manager. Its vision is: Make it easiest to
-install plugin somewhat following the 20% of efforts yields 80% of value rule.
-
-Difference names addon plugin: Almost none.
+install plugin somewhat following the “20% of efforts yields 80% of value”
+rule.
>
- :h plugin
-tells you about the old manual manual way of installing plugins. VAM helps
-keeping ~/.vim clean by separating plugins from each other.
+ :h plugin
+tells you about the old manual way of installing plugins. VAM helps keeping
+~/.vim clean by separating plugins from each other.
Features:
-
- Separate directories for each plugins
- Dependency resolution
- Popular VCS support: plugin supports fetching from Git, Mercurial,
@@ -74,7 +72,6 @@ Features:
- maintained pool of addons (vim-addon-manager-known-repositories)
which warns you if you try to install an outdated plugin
(have a look at it online : http://mawercer.de/~marc/vam/index.php)
-
- replicate your Vim setup by copying your .vimrc (See SetupVAM)
- load plugins lazily when Vim is already running. Some plugins require
additional tweaks for this to work
@@ -90,6 +87,9 @@ What does "Declarative package manager" mean? The final behaviour of Vim
should be declared once. Your ~/.vimrc and |:UpdateAddons| should be enough
to cause same Vim behaviour everywhere.
+Note: “Addon” here is a synonym for “plugin”: “a related collection of files
+ enhancing vim functionality”. “Plugin” may also mean “a .vim file inside
+ a plugin directory” hence using “addon”.
==============================================================================
2. Installation *VAM-installation*
Please sign in to comment.
Something went wrong with that request. Please try again.