Skip to content

Commit 8a18e34

Browse files
committed
Update setup doc
- remove pip based install process - add install process for vscode extension
1 parent a0f5b1f commit 8a18e34

1 file changed

Lines changed: 22 additions & 56 deletions

File tree

docs/02-setup.md

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

5-
## User installation guide
5+
### Install `chkware` toolset with Pipx
66

7-
This section describe the process on installation when you intent to use **chkware**.
7+
This section describe the installation process for [`chkware`](https://github.com/chkware/cli). The currently supported python version is **_Python 3.10.x_** You need to have this version of python in your OS to continue.
88

9-
### chkware toolset installation
10-
11-
12-
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.
13-
14-
15-
**Method 1: with pipx**
16-
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.
9+
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.
1810

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

@@ -28,62 +20,36 @@ Then use as following
2820
$ chk http some_file.chk
2921
```
3022

31-
**Method 2: with pip (globally)**
32-
33-
Alternatively you can install with `pip` like other regular python package following these step. However, it will install the package globally.
34-
35-
```bash
36-
$ python3 -m pip install -U chk
37-
```
38-
39-
Then use as following
40-
41-
```bash
42-
$ chk http some_file.chk
43-
```
44-
45-
**Method 3: with pip (locally)**
23+
### `chkware` toolset upgrade
4624

47-
To install under a separate environment, that don't change your global package space. You should install under a virtual environment.
25+
If you have installed with _pipx_ then use following to upgrade to latest released version.
4826

4927
```bash
50-
$ python3 -m venv .venv # create virtual environemnt
51-
$ source .venv/bin/activate # active virtual environemnt
52-
$ pip install -U chk
53-
```
54-
55-
Then use as following
56-
57-
```bash
58-
$ chk http some_file.chk
28+
$ pipx upgrade chk
5929
```
6030

61-
**Method 4: with pip (locally) from git**
31+
Otherwise, if _pip_ was used to install then same process given above should work for upgrade as well.
6232

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:
33+
---
6434

65-
```bash
66-
$ python3 -m venv .venv
67-
$ source .venv/bin/activate
68-
$ pip install -U https://github.com/chkware/cli/archive/main.tar.gz
69-
```
35+
### Install `chkware` extension for Visual Studio Code
7036

71-
Then use as following
37+
Get started writing `chkware` configurations with VS Code in three steps:
7238

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/)
39+
- Step 1: If you haven't done so already, install [chkware](#install-chkware-toolset-with-pipx)
7840

79-
---
41+
- Step 2: Install the `chkware` extension for VS Code
8042

81-
### chkware toolset upgrade
43+
New to `chkwere`? Read the `chkware` [**quick start**](quick-start) guide here.
8244

83-
If you have installed with **pipx** then use following to upgrade to latest released version.
45+
### Setup development environment for `chkware` extension
8446

85-
```bash
86-
$ pipx upgrade chk
87-
```
47+
Make sure you are doing following to develop this extension further in your machine.
8848

89-
Otherwise, if **pip** was used to install then same process given above should work for upgrade as well.
49+
- Run `npm install` to install dependencies for the first time
50+
- Run `npm run watch`
51+
- Press `f5`
52+
- Wait for the new window to be opened
53+
- Open command palette by pressing `ctrl` + `shift` + `p`
54+
- Search for `chkware` commands
55+
- After code changes, run `Developer: Reload Window` in the new window from command palette

0 commit comments

Comments
 (0)