Skip to content

Commit 77af1b5

Browse files
committed
Docs: clarify venv vs --user installation
1 parent c70da5e commit 77af1b5

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,14 @@
3030
```bash
3131
git clone https://github.com/guelfoweb/knockpy.git
3232
cd knockpy
33+
# recommended: install in a virtual environment
34+
python3 -m venv .venv
35+
. .venv/bin/activate
36+
python3 -m pip install -U pip
3337
pip install .
38+
39+
# alternative: install for the current user (no venv)
40+
# python3 -m pip install --user .
3441
```
3542

3643
⚠️ Recommended Python version: 3.9+

0 commit comments

Comments
 (0)