search

sshilovsky / fish-helix

helix key bindings for fish
The Unlicense
12 stars 0 forks source link

README enhancement request: Default bindings table or listing #1

Open varon opened 1 year ago

varon commented 1 year ago

Thank you for making this!

Is there any chance you could create a table or bindings list in the README of the default key map? It would help a lot with getting an idea for how this is used, as well as serving as a quick reference as new users start to adopt it.

sshilovsky commented 1 year ago

Happy you like it!

You can look at the bindings in https://github.com/sshilovsky/fish-helix/blob/main/fish_helix_key_bindings.fish

The commands can be tricky to understand, but the keys [are supposed to] mimic helix behavior exactly. I don't see much reason in documenting the bindings themselves, because helix users should be familiar with them.

The commands bound to the keys, on the other hand, should ideally be documented, but they are likely subject to change, when I get back to this project. I don't think it's worth documenting them in their current state.