update readme and dependence

Author: Neutree

COMTool/assets/screenshot_gragh.png

@@ -34,32 +34,48 @@ A cross platform serial debug tools written by python
 - [x] cross platform (Windows, Linux, macOS, Raspberry Pi)(code with python, only if your platform support python)
 - [x] reliable stability, no UI freeze
 - [x] multiple language support
-- [x] serial auto detect, and remember last selected support
-- [x] serial offline auto reconnect support
-- [x] port baudrate(any value) bytesize parity stopbits flow control etc. settings
-- [x] basic send/receive data (ascii and hex)
-- [x] send and receive data count
-- [x] clear received data area
-- [x] auto linefeed
-- [x] scheduled auto send
-- [x] send history and select send again
-- [x] custom most usage data items and one click to send
-- [x] CR LF(\r\n) or LF(\n)  support
-- [x] auto save settings
-- [x] key shortcuts like <kbd>Ctrl+Enter</kbd> to send
-- [x] escape character support, like `\r \n \t \x` etc.
+- [x] configs save and auto load(auto save settings when exit)
 - [x] multiple character encode support(`ASII,GBK(Chinese),UTF-8,UTF-16` etc.)
-- [x] receive and send record support add timestamp and save log to file
-- [x] send file
-- [x] unix terminal style color support(e.g.`\x1b[33;42mhello\x1b[0mhello2`)
-- [x] night theme and White theme
-- [x] rts & dtr control by hand
-- [x] protocol with customable encoding and decoding method support, 
-- [x] Custom shortcut send(in protocol plugin)
-- [x] TCP UDP support
-- [x] Terminal mode support
-- [x] plugin support(Create plugin see [docs/plugins.md](./docs/plugins.md))
-- [x] real time data graphic display
+- [x] night theme and White theme(can create more theme if you want)
+- [x] multiple connection type support, and support add connection plugin
+  - [x] serial port
+    - [x] serial auto detect, and remember last selected support
+    - [x] serial offline auto reconnect support
+    - [x] port baudrate(any value) bytesize parity stopbits flow control etc. settings
+    - [x] rts & dtr control by hand
+  - [x] TCP/UDP support, include client and server mode
+  - [x] SSH client support
+- [x] plugin support(Create plugin see [docs/plugins.md](./docs/plugins.md)), built-in plugin:
+  - [x] dbg plugin, support basic send receive debug operation
+    - [x] basic send/receive data (ascii and hex)
+    - [x] send and receive data count
+    - [x] clear received data area
+    - [x] auto linefeed
+    - [x] scheduled auto send
+    - [x] send history and select send again
+    - [x] custom most usage data items and one click to send
+    - [x] CR LF(\r\n) or LF(\n)  support
+    - [x] key shortcuts like <kbd>Ctrl+Enter</kbd> to send etc. More see help
+    - [x] receive and send record support add timestamp and save log to file
+    - [x] send file
+    - [x] unix terminal style color support(e.g.`\x1b[33;42mhello\x1b[0mhello2`)
+    - [x] escape character support, like `\r \n \t \x` etc.
+  - [x] protocol plugin, customize your own protocol
+    - [x] customize encoding and decoding method
+    - [x] customize shortcut key
+    - [x] escape character support, like `\r \n \t \x` etc.
+  - [x] terminal plugin, basic terminal interaction
+  - [x] gragh plugin
+    - [x] support dynamicly add gragh widgets, add gragh widgets you need
+    - [x] display line chart in realtime, support customize protocol header(support escape characters)
+    - [x] customable button to send data, support shortcut key
+
+## Installation
+
+There are two ways to install COMTool:
+
+* [Download binary files and run](#Install-binary) : For Windows or macOS, and simple usage users
+* [Install as python package(source code)](#Install-python-package) : For Linux, or need to use plugins' user, or users who know about python
 
 ## Install binary
 

README.MD

@@ -30,33 +30,47 @@ COMTool
 - [x] 跨平台 (Windows, Linux, macOS, Raspberry Pi)(使用 python 编写，只要你的平台支持 python)
 - [x] 可靠，界面不会卡死
 - [x] 多语言支持
-- [x] 串口自动检测，支持记住上次使用的串口号
-- [x] 串口断线自动重连
-- [x] 波特率（随意设置）、校验、停止位、流控等设置支持
-- [x] 基础收发功能(字符(ASCII) 和 十六进制(HEX))
-- [x] 收发计数
-- [x] 清空接收缓冲区支持
-- [x] 自动换行
-- [x] 定时发送
-- [x] 发送记录保存和再次选中发送
-- [x] 自定义常用发送内容，一键发送
-- [x] 两种常用换行符CR LF(\r\n) 和 LF(\n) 支持
-- [x] 自动保存设置（退出保存）
-- [x] 快捷键比如 <kbd>Ctrl+Enter</kbd> 发送数据
-- [x] 转义字符支持，比如 `\r \n \t \x` 等
-- [x] 多种字符编码格式支持，比如 `ASII,GBK(Chinese),UTF-8,UTF-16` 等
-- [x] 收发记录，以及添加时间戳和记录到文件功能
-- [x] 发送文件
-- [x] `unix` 终端风格颜色支持，比如`\x1b[33;42mhello\x1b[0mhello2`
 - [x] 白色主题和黑色主题切换
-- [x] `rts` 和 `dtr` 手动控制
-- [x] 自定义协议编解码支持
-- [x] 自定义快捷键发送（在协议功能里面）
-- [x] TCP UDP 支持
-- [x] 终端模式支持
-- [x] 插件支持（插件开发请看[docs/plugins_zh.md](./docs/plugins_zh.md)）
-- [x] 实时图像数据显示
-
+- [x] 多种字符编码格式支持，比如 `ASII,GBK(Chinese),UTF-8,UTF-16` 等
+- [x] 自动保存设置（退出保存）
+- [x] 多种连接方式支持，同时支持编写连接插件
+  - [x] 串口 支持
+    - [x] 串口自动检测，支持记住上次使用的串口号
+    - [x] 串口断线自动重连
+    - [x] 波特率（随意设置）、校验、停止位、流控等设置支持
+    - [x] `rts` 和 `dtr` 手动控制
+  - [x] TCP/UDP 支持，包括客户端和服务端模式支持
+  - [x] SSH 客户端支持
+- [x] 插件支持（插件开发请看[docs/plugins_zh.md](./docs/plugins_zh.md)）)，内置插件如下：
+  - [x] 调试插件，基本收发数据调试
+    - [x] 基础收发功能(字符(ASCII) 和 十六进制(HEX))
+    - [x] 收发计数
+    - [x] 清空接收缓冲区支持
+    - [x] 自动换行
+    - [x] 定时发送
+    - [x] 发送记录保存和再次选中发送
+    - [x] 自定义常用发送内容，一键发送
+    - [x] 两种常用换行符CR LF(\r\n) 和 LF(\n) 支持
+    - [x] 快捷键比如 <kbd>Ctrl+Enter</kbd> 发送数据
+    - [x] 转义字符支持，比如 `\r \n \t \x` 等
+    - [x] 收发记录，以及添加时间戳和记录到文件功能
+    - [x] 发送文件
+    - [x] `unix` 终端风格颜色支持，比如`\x1b[33;42mhello\x1b[0mhello2`
+  - [x] 协议插件，可自定义收发协议
+    - [x] 自定义协议编解码支持
+    - [x] 自定义快捷键发送
+  - [x] 终端插件， 基本终端功能
+  - [x] 图表插件
+    - [x] 支持动态添加图表控件，添加你需要的控件
+    - [x] 实时显示折线图，支持自定义协议头（支持转移符）
+    - [x] 自定义按钮来发送数据，支持自定义快捷键
+
+## 安装
+
+有两种安装方式：
+
+* [下载二进制文件并运行](#安装可执行程序（无需安装，直接执行）)： 适合 Windows 或 macOS，以及简单使用的用户
+* [以 python 包方式安装(源码安装)](#以-python-包形式安装)： 适合 Linux 用户， 以及需要使用插件的用户，或者熟悉 python 的用户
 
 ## 安装可执行程序（无需安装，直接执行）
 

README_ZH.MD

@@ -7,3 +7,4 @@ paramiko
 pyte
 pyperclip
 coloredlogs
+pyqtgraph

requirements.txt

@@ -21,7 +21,7 @@
     ret = os.system("sudo apt install python3 python3-pip python3-pyqt5")
     if ret != 0:
         raise Exception("install python3 pyqt5 failed")
-    ret = os.system("sudo pip3 install --upgrade pyserial requests Babel qtawesome paramiko pyte pyperclip coloredlogs")
+    ret = os.system("sudo pip3 install --upgrade pyserial requests Babel qtawesome paramiko pyte pyperclip coloredlogs pyqtgraph")
     if ret != 0:
         raise Exception("install packages failed")
     installRequires = []
@@ -34,7 +34,8 @@
                       'paramiko',
                       'pyte',
                       'pyperclip',
-                      'coloredlogs'
+                      'coloredlogs',
+                      'pyqtgraph'
                       ]
 
 setup(