Skip to content

Commit 3943971

Browse files
committed
docs: update with notes part
1 parent a50d85c commit 3943971

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

docs/setup.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,22 @@ pip install -U chk
1414

1515
To upgrade to the next released version, run the same command.
1616

17+
:::note
18+
19+
- You can always install directly from git
20+
21+
```bash
22+
# to install latest stable version
23+
pip install -U git+https://github.com/chkware/cli@main
24+
25+
# to install a tagged version, fx: v0.4.0
26+
pip install -U git+https://github.com/chkware/cli@v0.4.0
27+
```
28+
29+
- It is recommended to [use a virtual environment](https://docs.python.org/3/library/venv.html#creating-virtual-environments) when using via `pip`.
30+
31+
:::
32+
1733
### Install _CHKware_ toolset with Pipx
1834

1935
The best way to setup any python app is manage it via [pipx](https://pypa.github.io/pipx/). Pipx is a standard PyPi python application manager. Pipx creates separate virtual environment for given installable package. So, your system have less side effect.

0 commit comments

Comments
 (0)