Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

the mechanism of installation #102

Open
lihao2333 opened this issue Jul 14, 2018 · 4 comments
Open

the mechanism of installation #102

lihao2333 opened this issue Jul 14, 2018 · 4 comments

Comments

@lihao2333
Copy link

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

@chrisbra
Copy link

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

@lihao2333
Copy link
Author

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

@arvind-iyer
Copy link

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

@kiryph
Copy link

kiryph commented Feb 13, 2019

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants