Skip to content

Commit a046e7c

Browse files
committed
Setup guide update
1 parent 39002be commit a046e7c

1 file changed

Lines changed: 35 additions & 9 deletions

File tree

docs/02-setup.md

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,19 @@
22
title: Setup
33
---
44

5-
### Installation
5+
## User installation guide
6+
7+
This section describe the process on installation when you intent to use **chkware**.
8+
9+
### chkware toolset installation
610

711

812
The currently supported python version is **_Python 3.10.x_** You need to have this version of python in your OS to continue any of the following steps.
913

1014

1115
**Method 1: with pipx**
1216

13-
The best way to setup any python app is manage it via [pipx](https://pypa.github.io/pipx/). Pipx is a standred pypi python application manager.
17+
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.
1418

1519
First, [Install pipx](https://pypa.github.io/pipx/installation/). Then run
1620

@@ -21,45 +25,60 @@ $ pipx install chk
2125
Then use as following
2226

2327
```bash
24-
$ chk http SomeFile.chk
28+
$ chk http some_file.chk
2529
```
2630

2731
**Method 2: with pip (globally)**
2832

2933
Alternatively you can install with `pip` like other regular python package following these step. However, it will install the package globally.
3034

3135
```bash
32-
$ python3 -m pip install -U pip # upgrade pip
3336
$ python3 -m pip install -U chk
3437
```
3538

3639
Then use as following
3740

3841
```bash
39-
$ python3 -m chk http SomeFile.chk
42+
$ chk http some_file.chk
4043
```
4144

4245
**Method 3: with pip (locally)**
4346

44-
To install under a seperate environment, that don't change your global package space. Install under a virtual env.
47+
To install under a separate environment, that don't change your global package space. You should install under a virtual environment.
4548

4649
```bash
4750
$ python3 -m venv .venv # create virtual environemnt
4851
$ source .venv/bin/activate # active virtual environemnt
49-
$ pip install -U pip # upgrade pip
5052
$ pip install -U chk
5153
```
5254

5355
Then use as following
5456

5557
```bash
58+
$ chk http some_file.chk
59+
```
60+
61+
**Method 4: with pip (locally) from git**
62+
63+
To install latest version or a specific version from source code, under a separate environment, that don't change your global package space. Try following:
64+
65+
```bash
66+
$ python3 -m venv .venv
5667
$ source .venv/bin/activate
57-
$ python -m chk http SomeFile.chk
68+
$ pip install -U https://github.com/chkware/cli/archive/main.tar.gz
5869
```
5970

71+
Then use as following
72+
73+
```bash
74+
$ chk http some_file.chk
75+
```
76+
77+
Read more about this process in [‘pip install’ From a Git Repository](https://adamj.eu/tech/2019/03/11/pip-install-from-a-git-repository/)
78+
6079
---
6180

62-
### Upgrade
81+
### chkware toolset upgrade
6382

6483
If you have installed with **pipx** then use following to upgrade to latest released version.
6584

@@ -68,3 +87,10 @@ $ pipx upgrade chk
6887
```
6988

7089
Otherwise, if **pip** was used to install then same process given above should work for upgrade as well.
90+
91+
---
92+
### chkware IDE extension installation
93+
94+
**chkware** will have your favorite IDE / editor integration so that it is easy for you to write `.chk` files. We are currently actively developing a Visual Studio Code extension. We will update this section with usage, once it's released.
95+
96+
[TBD]

0 commit comments

Comments
 (0)