Skip to content

Commit 06b4f5d

Browse files
committed
Docs on installation for quickstart
1 parent 29d0547 commit 06b4f5d

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

doc/quickstart.rst

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,29 @@
44
Quickstart
55
==========
66

7+
Installation
8+
------------
9+
10+
Assure you have at least tmux **>= 1.8** and python **>= 2.6**.
11+
12+
.. code-block::
13+
14+
$ pip install tmuxp
15+
16+
You can upgrade to the latest release with:
17+
18+
.. code-block::
19+
20+
$ pip install tmuxp -U
21+
22+
Then install :ref:`bash_completion`.
23+
724
CLI
825
---
926

1027
.. seealso:: :ref:`examples`, :ref:`cli`, :ref:`bash_completion`.
1128

12-
tmuxp launches sessions from a configuration file.
29+
tmuxp launches workspaces / sessions from JSON and YAML files.
1330

1431
Configuration files can be stored in ``$HOME/.tmuxp`` or in project
1532
directories as ``.tmuxp.py``, ``.tmuxp.json`` or ``.tmuxp.yaml``.

0 commit comments

Comments
 (0)