junegunn / fzf.vim

fzf :heart: vim
MIT License
9.52k stars 582 forks source link

README - Improve installation guide #1485

Open kevin-jones opened 1 year ago

kevin-jones commented 1 year ago

In addition to Plug, there are other popular plugin managers too and I spent quite a while trying to get fzf working as I didn't realise 2 plugins are required in vim. Online, I found quite a few posts on forums and blogs from people having similar trouble. Hopefully this documentation update helps others!

junegunn commented 1 year ago

Thanks but,

image

(https://github.com/junegunn/fzf.vim/commit/c0a5fee7071ed89602b9b59fb67e83d6cd23addc)

Can we be more clear than this? This is the very first sentence in the installation section of the page, and we haven't talked about any plugin manager yet.

So I'm really doubtful that adding more instructions and making the page longer will help people who don't even read a single sentence in the documentation.

junegunn commented 1 year ago

Also, this plugin will print this error message if the main Vim plugin is not installed.

https://github.com/junegunn/fzf.vim/blob/1dcdb21db618055134cd611f4f5918f6d00a5df0/autoload/fzf/vim.vim#L109-L111

image
kevin-jones commented 1 year ago

Can we be more clear than this?

You can, yes, that's why I've provided an update which follows the great examples set by all of the best README files for other vim plugins.

As the creator of Plug, perhaps you're reluctant, I don't know. It's unusual to have a vim plugin that relies on another vim plugin with almost the exact same name, especially when the other vim plugin isn't really just a vim plugin.

So - yes - you can be more clear. I try/install vim plugins all of the time - yours is the only one I got tripped up on and if you search online forums etc. there are a lots of other people that fell into the same trap as me.

Take it or leave it, up to you 🙂

junegunn commented 1 year ago

I try/install vim plugins all of the time

I need some clarification.

there are a lots of other people that fell into the same trap as me.

The documentation and the error message weren't clear enough from the start. Maybe many of the posts you saw were written before the progress was made.

I don't know which plugin manager you use, but I'm pretty sure you know how to install two plugins with it. And it's what the current documentation is telling you to do. I don't see much point in listing a growing set of commands for different plugin managers that are more or less the same.