Skip to content

Commit

Permalink
Merge pull request #3 from klardotsh/leader-mode-documentation
Browse files Browse the repository at this point in the history
Additional, updated documentation
  • Loading branch information
kdb424 authored Aug 25, 2018
2 parents 74ca5aa + c80c37f commit f19098a
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/feature_leader_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,10 @@ As you can see, you have a few function. You can use `SEQ_ONE_KEY` for single-ke

Each of these accepts one or more keycodes as arguments. This is an important point: You can use keycodes from **any layer on your keyboard**. That layer would need to be active for the leader macro to fire, obviously.

If you would rather end the sequence with enter instead of having a timeout, include the line `#define LEADER_MODE` in your config.h and you can take as long as you want. If you want to cancel your action, simply press the leader key again.
If you would rather end the sequence with Enter instead of having a timeout,
include the line `#define LEADER_MODE_ENTER` in your config.h and you can take
as long as you want. If you want to cancel your action, simply press the leader
key again. To reuse an above example, you could type `<Leader>dds<Enter>` in any
amount of time to trigger the DuckDuckGo search macro, or `<Leader>dd<Leader>`
to cancel partway through. Leader sequences will _not_ auto-trigger without
hitting Enter with `LEADER_MODE_ENTER` defined.

0 comments on commit f19098a

Please sign in to comment.