search

tpope / vim-commentary

commentary.vim: comment stuff out
http://www.vim.org/scripts/script.php?script_id=3695
5.9k stars 214 forks source link

Installation instructions for people with pre-Git-ted configs #128

Closed PeterJRiches closed 4 years ago

PeterJRiches commented 4 years ago

Problem

The current installation instructions clone from this repository into the user's .vim configuration directory structure, and that works great if the user is not already using git to look after their configs, like I do. The problem with this repo being cloned within an outer repo is that git can assume that the inner repo is a malformed or incomplete git submodule. (I deleted my local commentary repo when this happened to me, and modified my method of installation as below.)

Proposal

For people who use git to oversee their configs, the following two lines can replace the git clone... command in the installation instructions in README.markdown:

git submodule add https://tpope.io/vim/commentary.git commentary git commit -m"Added Vim commentary plugin as a git submodule"

PeterJRiches commented 4 years ago

Apologies, @tpope I have closed this for you. I accidentally submitted it twice because my internet connection was flaking out last night so the website didn't show me that my first attempt had gone through. I hope I did not offend, and I do appreciate your efforts.