Skip to content

Commit 13ad6b7

Browse files
committed
更新使用说明
1 parent 2ee8a58 commit 13ad6b7

7 files changed

Lines changed: 21 additions & 7 deletions

File tree

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,34 @@
44
query Python API and third party library API via GUI interface.
55

66
# 安装
7+
8+
## 方法一
9+
10+
– 使用[kdPythonInstaller(https://github.com/bkdwei/kdPythonInstaller/releases/download/v1.0.0/kdPythonInstaller-1.0.0.exe/) 快速安装python和kdPythonAPIViewer
11+
12+
## 方法二
13+
714
- 安装python3和pip,[安装包地址](https://www.python.org/downloads/ 下载地址)
815
- 使用pip安装kdPythonAPIViewer,命令
916
** pip install kdPythonAPIViewer **
1017
- 点击桌面的快捷方式或开始菜单启动kdPythonAPIViewer
1118

12-
# 功能特点
13-
- 输入from PyQt5.QtWidgets import QMainWindow,查询QMainWindow的API
14-
- 安装新的模块后,可刷新系统缓存的API
15-
- 当包的描述文档太大时,可以设置仅显示类的文档
16-
- 可通过悬浮按钮隐藏或显示主窗体,方便开发人员随时随地查询API
17-
1819
# 截图
1920

20-
![kdPythonAPIViewer_screenshot](https://github.com/bkdwei/kdPythonAPIViewer/blob/master/doc/kdPythonAPIViewer_screenshot.png "截图")
21+
![kdPythonAPIViewer_screenshot](/screenshot/os.jpg)
22+
![kdPythonAPIViewer_screenshot](/screenshot/os.path.jpg)
23+
![kdPythonAPIViewer_screenshot](/screenshot/QLineEdit.setText.jpg)
24+
![kdPythonAPIViewer_screenshot](/screenshot/QLine)
25+
![kdPythonAPIViewer_screenshot](/screenshot/QLineEdit.show.jpg)
26+
27+
# 使用说明
28+
- 首次使用或安装了新的Python库时,需要先点击“缓存Python库”
29+
- 选择左侧下拉框中的库,然后在类的输入框任意输入一个类的名称即可加载该类的API。比如下拉框选择PyQt5,在类的输入框键入qli即可显示PyQt5.Qt.QLineEdit组件,回车即可显示API文档。![kdPythonAPIViewer_screenshot](/screenshot/使用说明.jpg)
30+
- 加载完类的文档后,可以点击方法与属性下拉框,查看该类对应的方法和属性
31+
- 当库的描述文档太大时(比如PyQt5.QtWidgets的文档就特别大),可以设置仅显示类的文档
32+
33+
34+
2135

2236
# 提交bug和建议
2337
[提交bug和建议](https://github.com/bkdwei/kdPythonAPIViewer/issues)

screenshot/QLineEdit.setText.jpg

142 KB
Loading

screenshot/QLineEdit.show.jpg

133 KB
Loading

screenshot/os.jpg

149 KB
Loading

screenshot/os.path.jpg

120 KB
Loading

screenshot/qline.jpg

183 KB
Loading

screenshot/使用说明.jpg

148 KB
Loading

0 commit comments

Comments
 (0)