Skip to content

Commit 1b9e754

Browse files
committed
Add a note about how meow uses underlying key bindings
1 parent f6a1b48 commit 1b9e754

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

GET_STARTED.org

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,17 @@ If you want to give it a try without touching your configuration.
1818

1919
Continue with the next steps.
2020

21+
* Must read before you start
22+
Meow is designed to work as a layer on top of the default key
23+
bindings. For example, command ~meow-kill~ can be used to kill a
24+
selection, it works by simulating the keys that is specified by
25+
variable ~meow--kbd-kill-region~, which is ~C-w~ by default. In this way,
26+
it works even when an alternative package is introduce to provide an
27+
enhanced version of ~kill-region~. But if you bind a command with
28+
different behavior on ~C-w~, ~meow-kill~ will not work as expected. In
29+
this case, you have to modify the variable ~meow--kbd-kill-region~ to
30+
match the rules. The same applies to other ~meow-*~ commands.
31+
2132
* Set up command layout
2233
Meow has no default command layout.
2334
You can write your own setup function from scratch or pick one from below as your starting point.

0 commit comments

Comments
 (0)