Skip to content

Commit 85f575e

Browse files
committed
update: README.md
1 parent b42a8ae commit 85f575e

File tree

2 files changed

+72
-3
lines changed

2 files changed

+72
-3
lines changed

README.md

Lines changed: 72 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,72 @@
1-
# thonny-quecpython
2-
构建python源码包与二进制包
3-
> python -m build
1+
# QuecPython Programing Kits for Thonny
2+
3+
Powered by [QuecPython Group](https://python.quectel.com/), provide support for programming based on the quecpython platform on Thonny. Hereinafter collectively referred to as "**Quecpython Kits**".
4+
5+
## View Display
6+
7+
![](./images/qpy_view.png)
8+
9+
## Install
10+
11+
### install with pip
12+
13+
now, we just assume you want to install thonny(with Quecpython Kits) on your own python environment(maybe a new virtual environment or a existed one).
14+
15+
if you want to make a new one, you need to run below two steps:
16+
17+
1. make new python virtual environment.
18+
19+
> shell: `python -m venv {virtual_environment_install_path}`
20+
21+
2. activate your the virtual environment.
22+
23+
> windows: `{virtual_environment_install_path}\Scripts\activate`.
24+
>
25+
> macos or unix: `source {virtual_environment_install_path}/bin/activate` .
26+
27+
else you just need to do:
28+
29+
3. install
30+
31+
> shell: `pip install -i {pypi_site_url} thonny-quecpython`
32+
>
33+
> here is some web site for pypi download below, you can choose one.
34+
>
35+
> | pypi_site_url |
36+
> | ----------------------------------------- |
37+
> | http://pypi.douban.com/simple/ |
38+
> | https://pypi.tuna.tsinghua.edu.cn/simple/ |
39+
> | http://mirrors.aliyun.com/pypi/simple/ |
40+
> | https://pypi.mirrors.ustc.edu.cn/simple/ |
41+
>
42+
> when you install `thonny-quecpython`, the `thonny>=4.1.1` will be installed automatically.
43+
44+
1. start thonny
45+
46+
> shell: `python -m thonny`
47+
> when you start thonny program, it will load plugins automatically(including Quecpython Kits).
48+
49+
### Install with thonny
50+
51+
before installing QuecPython Kits on this way, you need to install Thonny application first.
52+
53+
install using thonny plugin manager from pypi.
54+
55+
1. Go to <font color='orange'>`Thonny → Tools → Manage plug-ins`</font>
56+
2. Search for <font color='orange'>`thonny-quecpython`</font>
57+
3. Click <font color='orange'>`Install`</font>
58+
59+
install manually from local file.
60+
61+
1. Download using the [QuecPython/thonny-quecpython/releases](https://github.com/QuecPython/thonny-quecpython/releases)(wheel or tar package file).
62+
2. Go to <font color='orange'>`Thonny → Tools → Manage plug-ins…`</font>
63+
3. Click <font color='orange'>`Install from local file`</font>
64+
4. Find and select the prefered file.
65+
66+
## Activating Quecpython Kits.
67+
68+
1. After installing, and starting thonny, the Quecpython Kits already loaded.
69+
2. Go to <font color='orange'>`Thonny → Tools → QuecPython Kits`</font>.
70+
3. or Go to <font color='orange'>`Thonny → Views → QuecPython Kits`</font>.
71+
4. Select <font color='orange'>`QuecPython Kits`</font>
72+

images/qpy_view.png

23.8 KB
Loading

0 commit comments

Comments
 (0)