aboutsummaryrefslogtreecommitdiffstats
path: root/pkg/dome-key.in.rb
diff options
context:
space:
mode:
authorTeddy Wing2018-11-22 23:36:28 +0100
committerTeddy Wing2018-11-22 23:36:28 +0100
commita8a36293283f4df90f37e29bdc654908ec943e6b (patch)
treef9bbd9e4330b3419bf2f7400af1079b4cb7210e4 /pkg/dome-key.in.rb
parentbffe56397945195c76bf95a81c0281aef5430803 (diff)
downloadDomeKey-a8a36293283f4df90f37e29bdc654908ec943e6b.tar.bz2
HomebrewFormula: Add `--reload-mappings` mention in Caveats
Instruct users to reload mappings if `dome-key` is running. This could happen if the install commands were copy-pasted from the website: $ brew install teddywing/DomeKey/dome-key $ brew services start teddywing/DomeKey/dome-key At this point, `dome-key` would already have been started, and the new mappings wouldn't be loaded into the running process. Also indent the shell commands to differentiate them from the text.
Diffstat (limited to 'pkg/dome-key.in.rb')
-rw-r--r--pkg/dome-key.in.rb24
1 files changed, 14 insertions, 10 deletions
diff --git a/pkg/dome-key.in.rb b/pkg/dome-key.in.rb
index c2e306d..ddfcdf7 100644
--- a/pkg/dome-key.in.rb
+++ b/pkg/dome-key.in.rb
@@ -21,16 +21,20 @@ class DomeKey < Formula
def caveats; <<~EOS
To get started with a set of mappings, try running the these commands:
- mkdir -p $$HOME/.config/dome-key
- cat <<EOM > $$HOME/.config/dome-key/mappings.dkmap
- map <Play> <Nop>
-
- mode <Play><Play> {
- map <Up> <Left>
- map <Play> <Space>
- map <Down> <Right>
- }
- EOM
+ mkdir -p $$HOME/.config/dome-key
+ cat <<EOM > $$HOME/.config/dome-key/mappings.dkmap
+ map <Play> <Nop>
+
+ mode <Play><Play> {
+ map <Up> <Left>
+ map <Play> <Space>
+ map <Down> <Right>
+ }
+ EOM
+
+ If `dome-key` is already running, load the new mappings:
+
+ dome-key --reload-mappings
EOS
end