Skip to content

Commit 2619643

Browse files
committed
docs: Update for links, installation, etc
1 parent 2b82939 commit 2619643

File tree

3 files changed

+16
-18
lines changed

3 files changed

+16
-18
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ connect to a live tmux session:
5555
<libtmux.server.Server object at 0x7fbd622c1dd0>
5656
```
5757

58-
FYI: You can also use [tmuxp]'s [`tmuxp shell`] to drop straight into your
58+
Tip: You can also use [tmuxp]'s [`tmuxp shell`] to drop straight into your
5959
current tmux server / session / window pane.
6060

6161
[tmuxp]: https://tmuxp.git-pull.com/

docs/properties.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,6 @@ $ tmux
1919

2020
Make sure you have {ref}`libtmux installed <installation>`:
2121

22-
```{code-block} sh
23-
24-
pip install libtmux
25-
26-
```
27-
28-
To upgrade:
29-
30-
```{code-block} sh
31-
32-
pip install -U libtmux
33-
34-
```
35-
3622
:::::
3723

3824
terminal two, `python` or `ptpython` if you have it:

docs/quickstart.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Next, ensure `libtmux` is installed:
2727

2828
```{code-block} bash
2929
30-
$ [sudo] pip install libtmux
30+
$ pip install --user libtmux
3131
3232
```
3333

@@ -65,15 +65,17 @@ $ python
6565
6666
```
6767

68-
For commandline completion, you can also use [ptpython][ptpython].
68+
For commandline completion, you can also use [ptpython].
6969

7070
```{code-block} bash
7171
72-
$ [sudo] pip install ptpython
72+
$ pip install --user ptpython
7373
$ ptpython
7474
7575
```
7676

77+
[ptpython]: https://github.com/prompt-toolkit/ptpython
78+
7779
```{module} libtmux
7880
7981
```
@@ -89,6 +91,16 @@ First, we can grab a {class}`Server`.
8991
9092
```
9193

94+
:::{tip}
95+
96+
You can also use [tmuxp]'s [`tmuxp shell`] to drop straight into your
97+
current tmux server / session / window pane.
98+
99+
[tmuxp]: https://tmuxp.git-pull.com/
100+
[`tmuxp shell`]: https://tmuxp.git-pull.com/cli.html#shell
101+
102+
:::
103+
92104
:::{note}
93105

94106
You can specify a `socket_name`, `socket_path` and `config_file`

0 commit comments

Comments
 (0)