Skip to content

Commit

Permalink
Explain why pipx, but allow pip too
Browse files Browse the repository at this point in the history
As suggested by Lecrapouille and cgestes
in #332, #366, #343.
  • Loading branch information
gdubicki authored and dmerejkowsky committed Dec 16, 2023
1 parent 1e0226c commit b7a961c
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 9 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,15 @@ repositories.

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

## Requirements

Python **3.7** or later

## Installation

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

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

## Usage Example

Expand Down
20 changes: 15 additions & 5 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,24 @@
# Getting started

## Requirements

Python 3.7 or later

## Installing tsrc

The recommended way to install `tsrc` is to use [pipx](https://pypa.github.io/pipx/)
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.

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

You can also install `tsrc` with `pip` if you know what you are doing :)
Recommended:
```shell
pipx install tsrc
```

Acceptable, if you know what you are doing:
```shell
pip install tsrc
```

## Checking tsrc installation

Expand Down

0 comments on commit b7a961c

Please sign in to comment.