vim-commentary icon indicating copy to clipboard operation
vim-commentary copied to clipboard

the mechanism of installation

Open lihao2333 opened this issue 7 years ago • 4 comments

hi I didn't see any information about the path of the project. How do you install this project? I thought it should write something to vimrc at least.
Thank you

lihao2333 avatar Jul 14 '18 04:07 lihao2333

What exactly are you missing from https://github.com/tpope/vim-commentary#installation

chrisbra avatar Jul 14 '18 11:07 chrisbra

Yeah, I install successfully following the instructions. But why executing helptags commentary/doc can install it? For example, if I change the name of the directory or file, what else configuration should I change? I'm a vim fresh man, Thank you very much

lihao2333 avatar Jul 14 '18 15:07 lihao2333

The helptags command tells vim where any new help or documentation files are so that you would be able to run :help Commentary or similar commands to get details about the plugin

arvind-iyer avatar Oct 10 '18 01:10 arvind-iyer

But why executing helptags commentary/doc can install it?

This does not install the plugin: arvind-iyer has explained this line.

You can install the plugin by dowloading only the file plugin/commentary.vim into ~/.vim/pack/tpope/start/vim-commentary/plugin/commentary.vim.

However, having the documentation is very helpful and therefore simply follow the four steps

  1. create dir,
  2. change to it,
  3. use git to get the repo (you could add --depth 1 to avoid pulling the complete history which you might not need) and
  4. finally update the helptags

I thought it should write something to vimrc at least.

This is necessary if you use a plugin manager such as vundle, vim-plug and others. They existed before vim8 added the packages feature. The package feature allows you to install everything in an orderly fashion without the need to touch your vimrc. If you use vim7, you can use https://github.com/tpope/vim-pathogen to have a similar installation experience.

However, no one stops you to use vundle and the like. They have their own documentation and explain their usage on their website.

kiryph avatar Feb 13 '19 08:02 kiryph