Skip to content

Commit 82b4f42

Browse files
hydrothohydrotho
committed
docs: add description
1 parent 7111183 commit 82b4f42

File tree

3 files changed

+97
-1
lines changed

3 files changed

+97
-1
lines changed

‎README.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# COMTool ![Build and Release Status](https://github.com/hydrotho/COMTool/actions/workflows/main.yml/badge.svg)
2+
3+
[English](README.md) | [中文](README_zh.md)
4+
5+
COMTool, an efficient serial port debugging tool, specifically designed for receiving and transmitting data through serial ports in TEXT and HEX modes.
6+
7+
## Quick Start
8+
9+
### Installation
10+
11+
Download prebuilt statically-linked binaries, sdist and wheel files from [Releases](https://github.com/hydrotho/COMTool/releases/latest) for Linux, Windows and macOS.
12+
13+
### Usage
14+
15+
Once COMTool is launched, you can easily switch between TEXT and HEX modes by pressing `Control+T`.
16+
17+
```shell
18+
❯ COMTool --help
19+
20+
Usage: COMTool [OPTIONS]
21+
22+
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────╮
23+
│ --version │
24+
│ * --port TEXT [required] │
25+
│ * --baudrate INTEGER [required] │
26+
│ --bytesize INTEGER 5, 6, 7, 8 │
27+
│ [default: 8] │
28+
│ --parity TEXT N: None, E: Even, O: Odd, M: Mark, S: Space │
29+
│ [default: N] │
30+
│ --stopbits INTEGER 1, 1.5, 2 │
31+
│ [default: 1] │
32+
│ --xonxoff │
33+
│ --rtscts │
34+
│ --dsrdtr │
35+
│ --install-completion Install completion for the current shell. │
36+
│ --show-completion Show completion for the current shell, to copy it or customize the │
37+
│ installation. │
38+
│ --help Show this message and exit. │
39+
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
40+
```
41+
42+
## Support
43+
44+
If you encounter any issues or have any suggestions, please [open an issue](https://github.com/hydrotho/COMTool/issues).
45+
46+
## License
47+
48+
This project is licensed under the MIT License, see the [LICENSE](LICENSE) file for details.

‎README_zh.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# COMTool ![Build and Release Status](https://github.com/hydrotho/COMTool/actions/workflows/main.yml/badge.svg)
2+
3+
[English](README.md) | [中文](README_zh.md)
4+
5+
COMTool，一款高效的串口调试工具，专为 TEXT 和 HEX 模式下的串口数据收发设计。
6+
7+
## 快速开始
8+
9+
### 安装
10+
11+
请从 [发布页](https://github.com/hydrotho/COMTool/releases/latest) 下载适用于 Linux、Windows 和 macOS 的预构建静态链接二进制、sdist 和 wheel 文件。
12+
13+
### 使用
14+
15+
启动 COMTool 后，通过按下 `Control+T` 键即可方便地在 TEXT 和 HEX 模式之间进行切换。
16+
17+
```shell
18+
❯ COMTool --help
19+
20+
Usage: COMTool [OPTIONS]
21+
22+
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────╮
23+
│ --version │
24+
│ * --port TEXT [required] │
25+
│ * --baudrate INTEGER [required] │
26+
│ --bytesize INTEGER 5, 6, 7, 8 │
27+
│ [default: 8] │
28+
│ --parity TEXT N: None, E: Even, O: Odd, M: Mark, S: Space │
29+
│ [default: N] │
30+
│ --stopbits INTEGER 1, 1.5, 2 │
31+
│ [default: 1] │
32+
│ --xonxoff │
33+
│ --rtscts │
34+
│ --dsrdtr │
35+
│ --install-completion Install completion for the current shell. │
36+
│ --show-completion Show completion for the current shell, to copy it or customize the │
37+
│ installation. │
38+
│ --help Show this message and exit. │
39+
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
40+
```
41+
42+
## 支持
43+
44+
如果您遇到任何问题或有任何建议，欢迎 [提出问题](https://github.com/hydrotho/COMTool/issues)。
45+
46+
## 许可证
47+
48+
本项目采用 MIT 许可证，详情请参见 [LICENSE](LICENSE) 文件。

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
55
[project]
66
name = "comtool"
77
dynamic = ["version"]
8-
description = ''
8+
description = "COMTool, an efficient serial port debugging tool, specifically designed for receiving and transmitting data through serial ports in TEXT and HEX modes."
99
readme = "README.md"
1010
requires-python = ">=3.8"
1111
license = "MIT"

0 commit comments

Comments
 (0)