Skip to content

Commit af4bcea

Browse files
authored
Installation instructions
1 parent 8a2767c commit af4bcea

1 file changed

Lines changed: 24 additions & 7 deletions

File tree

README.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,42 @@ Use the `rich` command to highlight a variety of file types in the terminal, wit
88

99
## Installation
1010

11-
Rich-cli is distributed as a Python application, which you can install with Pip:
11+
There are a few options for installing Rich-CLI.
12+
13+
### Windows / Linux
14+
15+
You can install Rich-CLI with [pipx](https://pypa.github.io/pipx/).
1216

1317
```
14-
python -m pip install rich-cli
18+
pipx install rich-cli
1519
```
1620

17-
Alternatively, you can use `pipx` to install it globally:
21+
### MacOS
22+
23+
You can install Rich-CLI with [Homebew](https://brew.sh/).
1824

1925
```
20-
pipx install rich-cli
26+
brew tap textualize/rich
27+
brew install rich
2128
```
2229

23-
Once installed, you should have the `rich` command on your path.
30+
### Universal
31+
32+
Rich-CLI may be installed as a Python package.
33+
34+
ℹ️ It is reccomended to create a *virtual environment* first, to avoid any dependency conflicts.
2435

2536
```
26-
rich --help
37+
python -m pip install rich-cli
2738
```
2839

29-
ℹ️ More installation methods coming soon.
40+
## Rich command
41+
42+
Once installed you should have the `rich` command in your path. Run the following to see usage / help:
43+
44+
```
45+
rich --help
46+
```
3047

3148
## Syntax highlighting
3249

0 commit comments

Comments
 (0)