Skip to content

Commit

Permalink
Revise README a lot
Browse files Browse the repository at this point in the history
* Fix a use of punctuation.
* Fix a use of term.
* Add links and more description to "Requirements".
* Refine the levels of headers of "Typical usage".
* Add "Farewell to vim-flavor".
* Add "Philosophy".
* Add "License".
* Add "Author".
* Set textwidth.
  • Loading branch information
kana committed Mar 26, 2012
1 parent 49186b3 commit d6747bb
Showing 1 changed file with 86 additions and 19 deletions.
105 changes: 86 additions & 19 deletions README.asciidoc
@@ -1,15 +1,19 @@
= vim-flavor: a tool to manage your favorite Vim plugins
= vim-flavor, a tool to manage your favorite Vim plugins




== Set up the utility for a new-style plugin management
== Set up the tool for a new-style plugin management

=== Requirements

* Git 1.7.9 or later
* Ruby 1.9.2 or later
* Vim 7.3 or later
* http://git-scm.com/[Git] 1.7.9 or later
* http://www.ruby-lang.org/[Ruby] 1.9.2 or later
** Recommendation: Use http://beginrescueend.com/[RVM] or other tools
for ease of installation across different envinronments.
* http://www.vim.org/[Vim] 7.3 or later
** Note that Vim should be compiled as normal, big or huge version
to use most of plugins.


=== Supported platforms
Expand All @@ -28,7 +32,9 @@ gem install vim-flavor



== Start using vim-flavor
== Typical usage

=== Start using vim-flavor

----
cd $YOUR_REPOSITORY_FOR_DOTFILES
Expand Down Expand Up @@ -78,9 +84,7 @@ git commit -m 'Use vim-flavor to manage my favorite Vim plugins'
----




== Upgrade all plugins to the latest version
=== Upgrade all plugins to the latest version

----
vim-flavor upgrade
Expand All @@ -90,9 +94,7 @@ git commit -m 'Upgrade my favorite Vim plugins'
----




== Add more plugins into your dotfile repository
=== Add more plugins into your dotfile repository

----
cat >>VimFlavor <<'END'
Expand All @@ -111,9 +113,7 @@ git commit -m 'Use kana/vim-operator-replace'
----




== Remove plugins from your dotfile repository
=== Remove plugins from your dotfile repository

----
# Remove declarations of unused plugins from VimFlavor.
Expand All @@ -125,18 +125,85 @@ vim-flavor install
git add VimFlavor VimFlavor.lock
git commit -m 'Farewell kana/vim-smartchr'
----

== Install plugins into a non-standard directory
=== Install plugins into a non-standard directory
----
vim-flavor install --vimfiles-path=/cygdrive/c/Users/kana/vimfiles
----
=== Farewell to vim-flavor
----
rm -r ~/.vim-flavor
rm -r ~/.vim/flavors # or ~/vimfiles/flavors etc.

cd $YOUR_REPOSITORY_FOR_DOTFILES
rm VimFlavor VimFlavor.lock
git commit -am 'Farewell to vim-flavor'
----
== Philosophy
I know that there are several implementations for the same purpose and many
users love them, but all of them do not meet my taste. That's why I wrote
vim-flavor. The philosofy on vim-flavor is as follows:
Whole configuration including *versions of plugins* should be under a version
control system. All of existing implementations do not manage versions of
plugins. This means that *it's not possible to use the same configuration
across multiple environments* (the only one exception is using
https://github.com/tpope/vim-pathogen[pathogen] with Git submodules,
but you'll find it's painful to manually manage many plugins).
There should be a standard way to describe proper dependencies of plugins to
install dependencies without explicit declarations. Most of existing
implementations do not resolve dependencies automatically (the only one
exception is
https://github.com/MarcWeber/vim-addon-manager[vim-addon-manager], but it
doesn't take care about required versions). The configuration file formats of
vim-flavor are also used to describe dependencies of plugins with required
versions. This means that vim-flavor installs plugins and their dependencies
automatically (unfortunately this feature is not implemented yet, but it'll be
available soon).
Any software should have enough and reproducable test cases.
But existing implementations such as https://github.com/gmarik/vundle[vundle]
and https://github.com/Shougo/neobundle.vim[neobundle] are not developed so.
It's horrible for me.
Installation steps should be small, be reproducable, and not affect existing
envinronment as less as possible. Most of existing implementations require to
manually tweak `~/.vim` etc. It's painful to set up such stuffs manually
because a vimfiles path is varied on each platform.
Finally, a tool and files deployed by the tool should be uninstalled easily.
https://github.com/c9s/Vimana[Vimana] does not meet this because it directly
puts files into `~/.vim/colors` etc and it doesn't provide `uninstall`
command.
== License
vim-flavor is released under the terms of so-called MIT/X license.
See the LICENSE file for the details.
== Author
Kana Natsuno <http://whileimautomaton.net/>
// vim: filetype=asciidoc
// vim: filetype=asciidoc textwidth=78

0 comments on commit d6747bb

Please sign in to comment.