Update README.md to clarify how to set it up.

hadronized / hop.nvim

Neovim motions on speed!

Other

2.47k stars 137 forks source link

Update README.md to clarify how to set it up. #284

Closed ZXYFrank closed 2 years ago

ZXYFrank commented 2 years ago

I'm not an expert in vim and its config. It really take me quite a long time to merely find out how to get started. Given the fact that setup should be mandatorily called, I think the info is essential for a newbie to explore around hop inside instead of wasting hours to find how to set it up. 🤔 📖 Or we can consider put it in the wiki.

ii14 commented 2 years ago

It's the first sentence under "Installation":

Whatever solution / package manager you are using, you need to ensure that the setup Lua function is called at some point, otherwise the plugin will not work. [...]
require'hop'.setup()

hadronized commented 2 years ago

Thank you @ZXYFrank for your contribution. As @ii14 said, it’s already in the README. Also, your code advertised using Lua from VimL, which I think the community wants to move out. I know it’s opinionated but I’d rather not put that in the README and remain full Lua.