pkg/dome-key.in.rb: Add sample config setup to Brew Caveats

Make it faster to try out the program by providing copy-pastable
commands to get a sample config.

`HOME` needs two `$` to escape it from the Python templater.

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