# HG changeset patch # User Sean E. Russell # Date 1586901970 18000 # Tue Apr 14 17:06:10 2020 -0500 # Node ID 8523824031a8254da19be5dfb1609dcc05e9f6af # Parent 7088d5087c181830acdb9692eedf4f4aea558df7 Updates examples in README. diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Or, you can [download a binary](https://downloads.ser1.net/software). Put the executable in your path, and then use it to launch your terminal (or other application). For example, to auto-start the app from i3, put this in the `~/.i3/config`: ``` -exec --no-startup-id i3quake -p right -H 0.6 -t st +exec --no-startup-id i3quake -p right -H 0.6 st ``` Subsequent runs of i3quake will toggle showing the window, but it turns out that i3quake is not necessary because toggling can be performed with commands that can be bound directly in `~/.i3/config` without the overhead of forking a process. Add this binding to your `~/.i3/config`: @@ -41,20 +41,23 @@ ## Examples ```bash -$ i3quake # default use i3-sensible-terminal and open $SHELL -``` -```bash -$ i3quake -p right -H 0.5 -t termite -``` -```bash -$ i3quake -p right -H 0.5 -t termite # Opens termite to right -$ i3quake -p left -H 0.5 -m gvim -t gvim # Opens gvim to left, marked as "gvim" +$ # open terminal on left, half-screen +$ i3quake -p left -H 0.5 +$ # Open gvim on the right, marked as "gvim" +$ i3quake -p right -H 0.5 -m gvim gvim +$ # Open Conky on the left in "own-window" mode: +$ i3quake -p left -H 0.5 -m conky -- conky -o +$ # Run nvim in an st window from the top +$ i3quake -p top -H 0.75 -m nvim -- st -t nvim -w nvim nvim +Project ``` -The last example can be used to bind multiple utility programs to different keys that are popped-up on demand. For these "custom marked" applications, the mark is `i3quake`, so if you're binding this to a keysym in the config, for the above example you'd use: +The marked examples can be used to bind multiple utility programs to different keys that are popped-up on demand. For these "custom marked" applications, the mark is `i3quake`, so if you're binding this to a keysym in the config, for the above example you'd add this to your `~/.i3/config` file: -``` -bindsym $mod+g [con_mark="i3quakegvim"] scratchpad show +```bash +# For the default mark: +bindsym $mod+n [con_mark="i3quake"] scratchpad show +# For the "conky" mark: +bindsym $mod+x [con_mark="i3quakeconky"] scratchpad show ``` ## How