Skip to content

Commit 2ee7605

Browse files
committed
update installation docs
1 parent 4824880 commit 2ee7605

File tree

1 file changed

+7
-35
lines changed

1 file changed

+7
-35
lines changed

docs/getting-started/installation.md

Lines changed: 7 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -8,48 +8,26 @@ view.py requires [CPython](https://python.org/downloads/) 3.8 or above.
88

99
CPython is the reference/official implementation of Python. If you downloaded Python through [python.org](https://python.org) or some sort of system package manager (e.g. `apt`, `pacman`, `brew`), it's probably CPython.
1010

11-
## Installing with a Virtual Environment (Recommended)
11+
## Installing with Pipx (Recommended)
1212

13-
### Windows
13+
[pipx](https://pipx.pypa.io/stable/) can install CLIs into isolated environments. view.py recommends using `pipx` for installation, and then using `view init` to initialize a virtual environment in projects. For example:
1414

1515
```
16-
> py -3 -m venv .venv
17-
> .\.venv\activate
18-
> pip install view.py
16+
$ pipx install view.py
17+
... pipx output
18+
$ view init
1919
```
2020

21-
### Linux/macOS
22-
23-
```
24-
$ python3 -m venv .venv
25-
$ source .venv/bin/activate
26-
$ pip install view.py
27-
```
28-
29-
!!! question "Why a virtual environment?"
30-
31-
view.py is a large package with lots of dependencies, as well as a big [extension module](https://docs.python.org/3/extending/extending.html). If you have no idea what a virtual environment is or why they're useful, take a look at [Python's documentation](https://docs.python.org/3/library/venv.html).
32-
3321
## Installing via Pip
3422

35-
### Windows
36-
37-
```
38-
> py -3 -m pip install -U view.py
39-
```
40-
41-
### Linux/macOS
42-
4323
```
44-
$ python3 -m pip install view.py
24+
$ pip install view.py
4525
```
4626

4727
## Development Version
4828

4929
```
50-
$ git clone https://github.com/ZeroIntensity/view.py
51-
$ cd view.py
52-
$ pip install .
30+
$ pip install git+https://github.com/ZeroIntensity/view.py
5331
```
5432

5533
## Finalizing
@@ -58,16 +36,10 @@ To ensure you've installed view.py correctly, run the `view` command:
5836

5937
```
6038
$ view
61-
Welcome to view.py!
62-
Docs: https://view.zintensity.dev
63-
GitHub: https://github.com/ZeroIntensity/view.py
6439
```
6540

6641
If this doesn't work properly, try executing via Python:
6742

6843
```
6944
$ python3 -m view
70-
Welcome to view.py!
71-
Docs: https://view.zintensity.dev
72-
GitHub: https://github.com/ZeroIntensity/view.py
7345
```

0 commit comments

Comments
 (0)