aboutsummaryrefslogtreecommitdiffstats
path: root/pkg/dome-key.in.rb
diff options
context:
space:
mode:
Diffstat (limited to 'pkg/dome-key.in.rb')
-rw-r--r--pkg/dome-key.in.rb16
1 files changed, 16 insertions, 0 deletions
diff --git a/pkg/dome-key.in.rb b/pkg/dome-key.in.rb
index 686fc90..d6f6dc6 100644
--- a/pkg/dome-key.in.rb
+++ b/pkg/dome-key.in.rb
@@ -17,6 +17,22 @@ class DomeKey < Formula
"com.teddywing.dome-key"
end
+ 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
+ EOS
+ end
+
def plist; <<~EOS
${PLIST}
EOS