Skip to content

Commit c1ce96e

Browse files
committed
README update
1 parent 6c583a6 commit c1ce96e

File tree

1 file changed

+29
-13
lines changed

1 file changed

+29
-13
lines changed

README.rst

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,40 +30,56 @@ Install ``tmuxp``:
3030
$ pip install tmuxp
3131
3232
33-
See also: `Quickstart`_
34-
33+
See: `Quickstart`_
3534

3635
tmux bash completion
3736
""""""""""""""""""""
3837

38+
tmuxp uses ``switch-client`` for you if already in a TMUX client.
39+
3940
.. code-block:: bash
4041
41-
# tmuxp uses ``switch-client`` for you if already in a TMUX client.
42-
$ tmuxp attach-session<tab>
43-
$ tmuxp kill-session<tab>
42+
$ tmuxp attach-session<tab> # current sessions
43+
$ tmuxp kill-session<tab> # current sessions
44+
45+
Load a session configuration from a YAML or JSON file.
46+
47+
.. code-block:: bash
4448
45-
# load a session configuration from a YAML or JSON file.
4649
$ tmuxp load<tab>
4750
4851
See: `bash completion`_
4952

5053
load tmux sessions from yaml and json
5154
"""""""""""""""""""""""""""""""""""""
5255

56+
Load from ``~/.tmuxp.yaml`` or ``~/.tmuxp.json`` in current directory.
57+
5358
.. code-block:: bash
5459
55-
# Load from ``~/.tmuxp.yaml`` or ``~/.tmuxp.json`` in current directory.
5660
$ tmuxp load .
5761
58-
# Load ``myconfig.yaml``, checking current directory, then
59-
# ``$HOME/.tmuxp/myconfig.yaml``.
62+
Load ``myconfig.yaml``.
63+
64+
.. code-block:: bash
65+
6066
$ tmuxp load myconfig.yaml
6167
62-
tmuxp will prompt you if session is already running, press ``[Enter]``
63-
to attach the session automatically.
68+
``$ mkdir ~/.tmuxp`` and make a file ``~/.tmuxp/test.yaml``.
69+
70+
.. code-block:: yaml
71+
72+
session_name: my session
73+
windows:
74+
- window_name: my test window
75+
shell_command_before: cd ~
76+
panes:
77+
- pwd
78+
- pwd
79+
80+
.. code-block:: bash
6481
65-
If you load a config from *inside* tmux, tmuxp will offer to attach it
66-
for you.
82+
$ tmuxp load test.yaml
6783
6884
See: `Examples`_
6985

0 commit comments

Comments
 (0)