Skip to content

Commit c94c022

Browse files
committed
docs: redoing setup and update stability info
1 parent c756a03 commit c94c022

1 file changed

Lines changed: 26 additions & 3 deletions

File tree

docs/setup.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ hide_title: true
66

77
### Installation
88

9-
The currently supported python version is **\*Python 3.8.\*\*** You need to have this version of python in your OS to continue any of the following steps.
9+
10+
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.
11+
1012

1113
**Method 1: with pipx**
1214

@@ -18,6 +20,12 @@ First, [Install pipx](https://pypa.github.io/pipx/installation/). Then run
1820
$ pipx install chk
1921
```
2022

23+
Then use as following
24+
25+
```bash
26+
$ chk http SomeFile.chk
27+
```
28+
2129
**Method 2: with pip (globally)**
2230

2331
Alternatively you can install with `pip` like other regular python package following these step. However, it will install the package globally.
@@ -27,6 +35,12 @@ $ python3 -m pip install -U pip # upgrade pip
2735
$ python3 -m pip install -U chk
2836
```
2937

38+
Then use as following
39+
40+
```bash
41+
$ python3 -m chk http SomeFile.chk
42+
```
43+
3044
**Method 3: with pip (locally)**
3145

3246
To install under a seperate environment, that don't change your global package space. Install under a virtual env.
@@ -38,6 +52,13 @@ $ pip install -U pip # upgrade pip
3852
$ pip install -U chk
3953
```
4054

55+
Then use as following
56+
57+
```bash
58+
$ source .venv/bin/activate
59+
$ python -m chk http SomeFile.chk
60+
```
61+
4162
---
4263

4364
### Upgrade
@@ -54,10 +75,12 @@ Otherwise, if **pip** was used to install then same process given above should w
5475

5576
### Platform support
5677

57-
For now this tool is developed and tested on **macOS** only. We are working hard to make it available on Linux platform.
78+
This tool is tested to run on **Linux**, **Windows**, and **macOS** platform.
79+
80+
There is no native binary dependency, therefore it is expected on all the platform where supported Python version works. Please create an issue, if you need additional platform support.
5881

5982
---
6083

6184
### Stability
6285

63-
Current stability for this tool is _Pre - Alpha_
86+
Current stability for this tool is _Alpha_.

0 commit comments

Comments
 (0)