Skip to content

Commit 30784a8

Browse files
committed
README update
1 parent 5f0d037 commit 30784a8

File tree

1 file changed

+18
-37
lines changed

1 file changed

+18
-37
lines changed

README.rst

Lines changed: 18 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,21 @@ Open to testers
1717
tmuxp is still **alpha** code and needs a few more weeks until stable.
1818
See the `Issues tracker`_ to see known issues and for any other concerns.
1919

20+
Install
21+
"""""""
22+
23+
- install ``tmux``, at least version **1.8**
24+
- libyaml is installed for your distribution.
25+
26+
Install ``tmuxp``:
27+
28+
.. code-block:: bash
29+
30+
$ pip install tmuxp
31+
32+
33+
See also: `Quickstart`_
34+
2035

2136
tmux bash completion
2237
""""""""""""""""""""
@@ -39,15 +54,12 @@ load tmux sessions from yaml and json
3954
.. code-block:: bash
4055
4156
$ tmuxp load .
42-
43-
Load from ``~/.tmuxp.yaml`` or ``~/.tmuxp.json`` in current directory.
44-
45-
.. code-block:: bash
57+
# Load from ``~/.tmuxp.yaml`` or ``~/.tmuxp.json`` in current directory.
4658
4759
$ tmuxp load myconfig.yaml
4860
49-
Load ``myconfig.yaml``, checking current directory, then
50-
``$HOME/.tmuxp/myconfig.yaml``.
61+
# Load ``myconfig.yaml``, checking current directory, then
62+
# ``$HOME/.tmuxp/myconfig.yaml``.
5163
5264
tmuxp will prompt you if session is already running, press ``[Enter]``
5365
to attach the session automatically.
@@ -57,37 +69,6 @@ for you.
5769

5870
See: `Examples`_
5971

60-
Install
61-
"""""""
62-
63-
- install ``tmux``, at least version **1.8**
64-
- libyaml is installed for your distribution.
65-
66-
Install ``tmuxp``:
67-
68-
.. code-block:: bash
69-
70-
$ pip install tmuxp
71-
72-
``$ mkdir ~/.tmuxp`` and make a file ``~/.tmuxp/test.yaml``.
73-
74-
.. code-block:: yaml
75-
76-
session_name: my session
77-
windows:
78-
- window_name: my test window
79-
shell_command_before: cd ~
80-
panes:
81-
- pwd
82-
- pwd
83-
84-
With ``tmuxp``:
85-
86-
.. code-block:: bash
87-
88-
$ tmuxp load test.yaml
89-
90-
See also: `Quickstart`_
9172

9273
============== ==========================================================
9374
tmux support 1.8, 1.9-dev

0 commit comments

Comments
 (0)