search

Julian / lean.nvim

neovim support for the Lean theorem prover
MIT License
255 stars 25 forks source link

Add note for vim non-experts about LocalLeader. #259

Closed langfield closed 2 years ago

langfield commented 2 years ago

Add a note about how to remap <LocalLeader> before the key mappings table in the README.

I am by no means an expert with vim/neovim. Found the use of <LocalLeader> in the mappings table very confusing on first look, and the document that the :help <LocalLeader> command brings up is massive (over 1500 lines) and mostly irrelevant to using lean.nvim out of the box.

Feedback appreciated, not completely sure if this is useful.

Julian commented 2 years ago

Thanks! I'm super happy to add this sort of thing, definitely don't want to assume the audience isn't a vim expert!

That said, there's this just below the table:

Note

See :help if you haven't previously interacted with the local leader key. Some vim users remap this key to make it easier to reach, so you may want to consider what key that means for your own keyboard layout. My (Julian's) is set to , and my to , which may be a good choice for you if you have no other preference.

Did you see that note and still find it unclear? Or not see it and think it's better before the table rather than after? Or other?

Regardless thanks for any suggestion on making this clearer!

langfield commented 2 years ago

Thanks for replying so quickly! Yes I did see that note, and was still a bit confused. Nothing some googling wouldn't remedy, of course, but I think the more self-contained the installation is, the better.

Julian commented 2 years ago

Got it, sounds good -- appreciate the PR!