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

README - Improve installation guide #1485

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

kevin-jones
Copy link

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!

Although Plug is a fantastic vim plugin manager, there are other popular options 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
Copy link
Owner

Thanks but,

image

(c0a5fee)

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
Copy link
Owner

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

if !exists('*fzf#run')
throw "fzf#run function not found. You also need Vim plugin from the main fzf repository (i.e. junegunn/fzf *and* junegunn/fzf.vim)"
endif

image

@kevin-jones
Copy link
Author

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
Copy link
Owner

junegunn commented Jun 17, 2023

I try/install vim plugins all of the time

I need some clarification.

  • Did you read the instructions before installing this plugin? My guess is that you have prior experience with other plugins so you just skipped it over thinking it would be the same? (FYI, that's what I would usually do)
  • Did you read the instructions right after you failed to get it working? Or you read it after spending some time searching for the web for the resolution?
  • Did you see the error message saying that the dependency is not met? i.e. fzf#run function not found. You also need Vim plugin from the main fzf repository (i.e. junegunn/fzf *and* junegunn/fzf.vim)

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.

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

Successfully merging this pull request may close these issues.

2 participants