Skip to content

Commit 1cf5acd

Browse files
committed
Add some more details to qucikstart
1 parent 119112d commit 1cf5acd

File tree

1 file changed

+27
-10
lines changed

1 file changed

+27
-10
lines changed

doc/quickstart.rst

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,32 +10,49 @@ sessions using python code.
1010
In this example, we will launch a tmux session and control the windows
1111
from inside a live tmux session.
1212

13-
Control tmux via python
14-
-----------------------
13+
.. _requirements:
1514

16-
.. seealso:: :ref:`api`
15+
Requirements
16+
------------
1717

18-
.. todo:: Do a version of this with `sliderepl`_
18+
- `tmux`_
19+
- `pip`_ - for this handbook's examples
1920

20-
To begin, ensure the ``tmux`` program is installed.
21+
.. _pip: https://pip.pypa.io/en/stable/installing/
22+
.. _tmux: https://tmux.github.io/
2123

22-
Next, ensure ``libtmux`` (note the p!) is installed:
24+
.. _installation:
25+
26+
Installation
27+
------------
28+
29+
Next, ensure ``libtmux`` is installed:
2330

2431
.. code-block:: bash
2532
2633
$ [sudo] pip install libtmux
2734
35+
Start a tmux session
36+
--------------------
37+
2838
Now, let's open a tmux session.
2939

3040
.. code-block:: bash
3141
3242
$ tmux new-session -n bar -s foo
3343
34-
Why not just ``$ tmux``? We will assume you want to see the tmux changes
35-
in the current tmux session. So we will use:
44+
This tutorial will be using the session and window name in the example.
45+
46+
Window name ``-n``: ``bar``
47+
Session name ``-s``: ``foo``
48+
49+
Control tmux via python
50+
-----------------------
51+
52+
.. seealso:: :ref:`api`
53+
54+
.. todo:: Do a version of this with `sliderepl`_
3655

37-
Window name: ``bar``
38-
Session name: ``foo``
3956

4057
.. code-block:: bash
4158

0 commit comments

Comments
 (0)