Skip to content

Commit 0061c29

Browse files
committed
Explain why pipx, but allow pip too
As suggested by Lecrapouille and cgestes in your-tools#332, your-tools#366, your-tools#343.
1 parent 44f7efd commit 0061c29

File tree

2 files changed

+22
-9
lines changed

2 files changed

+22
-9
lines changed

README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,16 @@ repositories.
1717

1818
It can be [seen in action on asciinema.org](https://asciinema.org/a/131625).
1919

20+
## Requirements
21+
22+
23+
Python **3.7** or later
24+
2025
## Installation
2126

22-
The recommended way to install `tsrc` is to use [pipx](https://pipxproject.github.io/pipx/).
27+
Use `pipx` (recommended) or `pip` (ok, if you know what you're doing) to install.
2328

24-
* Make sure to have Python **3.7** or later installed.
25-
* Install `pipx`
26-
* Run `pipx install tsrc`.
29+
Please see the [installation docs](https://your-tools.github.io/tsrc/getting-started/#installing_tsrc) for more info.
2730

2831
## Usage Example
2932

docs/getting-started.md

+15-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,24 @@
11
# Getting started
22

3+
## Requirements
4+
5+
Python 3.7 or later
6+
37
## Installing tsrc
48

5-
The recommended way to install `tsrc` is to use [pipx](https://pypa.github.io/pipx/)
9+
The recommended way to install `tsrc` is to use [pipx](https://pypa.github.io/pipx/). This is because `pipx` automatically creates isolated environment for each app, so you won't get into dependencies versions conflicts and won't have to deal with manual virtualenvs management.
610

7-
* Make sure to have Python 3.7 or later installed.
8-
* Install pipx
9-
* Run `pipx install tsrc`
11+
`pip` will also work, but it will not give you these benefits.
1012

11-
You can also install `tsrc` with `pip` if you know what you are doing :)
13+
Recommended:
14+
```shell
15+
pipx install tsrc
16+
```
17+
18+
Acceptable, if you know what you are doing:
19+
```shell
20+
pip install tsrc
21+
```
1222

1323
## Checking tsrc installation
1424

0 commit comments

Comments
 (0)