Skip to content

Commit 80cb722

Browse files
committed
docs: 修正使用说明中的标点和格式
1 parent 7d90cb7 commit 80cb722

6 files changed

Lines changed: 73 additions & 82 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ _The application currently only supports the Chinese language._
2020

2121
</div>
2222

23-
VCF generator, input name and phone number to automatically generate VCF files for batch import into the address book.
23+
VCF generator, input name and phone number to automatically generate VCF files for batch importing into the address book.
2424

2525
[![License](https://img.shields.io/github/license/HelloTool/VCFGeneratorLiteForTkinter)](./LICENSE)
2626
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](./docs/CODE_OF_CONDUCT.md)
@@ -51,7 +51,7 @@ Different application packages have different environment requirements. Please c
5151
| Installer/Portable Package | Windows 7+ | x86_64 | Windows 7 requires patch files (see below for details) |
5252
| Zip Application | Python 3.12+ and Tkinter | No restrictions | - |
5353

54-
### File Download List
54+
### Get the Software Package
5555

5656
Get the software package through the following channels:
5757

@@ -69,7 +69,7 @@ File list for each system:
6969
## Usage
7070

7171
1. Open the app.
72-
2. Copy the name and phone number in the format of `Name PhoneNumber Note` on each line into the editing box below. The note can be ignored.
72+
2. Copy the name and phone number in the format of `Name PhoneNumber Note` on each line into the editing box below. The note can be omitted.
7373
```text
7474
Isaac Newton 13445467890 British mathematician
7575
Muhammad 13554678907
@@ -79,19 +79,19 @@ File list for each system:
7979
4. Copy the generated VCF file to your phone, select "Contacts" when opening the file, and then follow the prompts.
8080
5. Wait for the import to complete.
8181

82-
> [!NOTE]
82+
> [!NOTE] Note
8383
>
8484
> - Tabs will be automatically converted to spaces for processing.
85-
> - The program will automatically remove excess spaces from the input box.
85+
> - The program will automatically remove extra spaces from the input box.
8686
> - If there are multiple spaces in each line, all characters before the last space will be treated as names.
8787
>
8888
> For example, ` Han Meimei 13333333333 A well-known girl` will be recognized as
8989
>
90-
> ```text
91-
> Name: Han Meimei
92-
> Phone: 13333333333
93-
> Note: A well-known girl
94-
> ```
90+
>
91+
> > - Name: Han Meimei
92+
> > - Phone: 13333333333
93+
> > - Note: A well-known girl
94+
>
9595
9696
## Compatibility
9797

@@ -103,7 +103,7 @@ File list for each system:
103103
| Windows 10+ | Display Scaling | Unable to auto-scale when switching DPI; scaling adaptation is handled by the operating system |
104104
| Windows 10+ | Font Scaling | Font scaling not supported |
105105
| Windows 7+ | Display Scaling | Icon scaling only supports 100%, 125%, and 150% levels |
106-
| Windows 7 - 8.1 | App Launch | Requires patch |
106+
| Windows 7 ~ 8.1 | App Launch | Requires patches |
107107

108108
#### Special Notes
109109

@@ -124,7 +124,7 @@ File list for each system:
124124

125125
### vCard File Compatibility
126126

127-
This APP only supports generating version 2.1 vCard files that contain only name and phone number.
127+
This app only supports generating version 2.1 vCard files that contain only name and phone number.
128128

129129
| Third-party Application | Compatibility |
130130
| ----------------------- | ---------------------------------------------------------- |

README.zh.md

Lines changed: 16 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,6 @@ VCF 生成器,输入姓名与手机号则自动生成用于批量导入到通
4242
| 便携包 | 解压即用(支持U盘随身携带) | 免安装/临时使用 |
4343
| Zip 应用 | 双击直接运行 | 快速启动/跨平台使用 |
4444

45-
<!-- | Chocolatey | 命令行一键部署 | 自动化安装/集中管理/快速版本更新 |
46-
| Android 应用软件包 | 安装后使用 | 移动设备使用/临时处理需求 |
47-
| 网站 | 进入网站即可运行 | 临时使用/跨平台使用 | -->
48-
4945
### 环境要求
5046

5147
不同的应用包有一不同环境要求,您需要根据您的系统环境选择对应的应用包。
@@ -55,11 +51,7 @@ VCF 生成器,输入姓名与手机号则自动生成用于批量导入到通
5551
| 安装器/便携包 | Windows 7+ | x86_64 | Windows 7 需补丁文件(见下方说明) |
5652
| Zip 应用 | Python 3.12+ 与 Tkinter | 无限制 | - |
5753

58-
<!-- | Chocolatey | Chocolatey 2.0.0 | x86_64 | 需安装 Chocolatey |
59-
| Android 应用软件包 | Android 系统环境 | 未知 | Windows 11 需安装 WSA,Linux 需安装 Waydroid |
60-
| 网站 | 浏览器 | 无限制 | 需安装浏览器 | -->
61-
62-
### 文件下载列表
54+
### 获取软件包
6355

6456
通过以下渠道获取软件包:
6557

@@ -74,48 +66,43 @@ VCF 生成器,输入姓名与手机号则自动生成用于批量导入到通
7466
| 便携包 | `*_portable.zip` | 暂未提供 | 暂未提供 | 不支持 |
7567
| Zip 应用 | `*_zipapp.pyzw` | `*_zipapp.pyzw`(推荐) | `*_zipapp.pyzw`(推荐) | 不支持 |
7668

77-
<!-- | Chocolatey | 暂未提供 | 不支持 | 不支持 | 不支持 |
78-
| Android 应用软件包 | 暂未提供 | 暂未提供 | 不支持 | 暂未提供(推荐) |
79-
| 网站 | 暂未提供 | 暂未提供 | 不支持 | 暂未提供 | -->
80-
8169
## 使用方法
8270

83-
1. 把名字和电话以每行 `姓名 电话号码 备注` 的格式复制到下面的编辑框内,其中备注可忽略
71+
1. 把名字和电话以每行 `姓名 电话号码 备注` 的格式复制到下面的编辑框内,其中备注可忽略
8472
```text
8573
张三 13345367789 著名的法外狂徒
8674
李四 13445467890
8775
王五 13554678907
8876
赵六 13645436748
8977
```
90-
2. 点击“生成”,选择一个路径保存文件
91-
3. 将生成后的 VCF 文件复制到手机内,打开文件时选择使用“通讯录”,然后根据提示操作
78+
2. 点击“生成”,选择一个路径保存文件
79+
3. 将生成后的 VCF 文件复制到手机内,打开文件时选择使用“通讯录”,然后根据提示操作
9280
4. 等待导入完成。
9381

94-
> [!NOTE]
82+
> [!NOTE] 说明
9583
>
9684
> - 制表符会自动转换为空格处理,您可以同时使用制表符和空格分割。
9785
> - 程序会自动去除输入框内多余的空格。
9886
> - 如果每行有多个空格,则会将最后一个空格以前所有的字符当作姓名处理。
9987
>
10088
> 比如 `东坡居士 苏轼 13333333333 眉州眉山人` 将会被识别为
10189
>
102-
> ```text
103-
> 姓名:东坡居士 苏轼
104-
> 电话:13333333333
105-
> 备注:眉州眉山人
106-
> ```
90+
> > - 姓名:东坡居士 苏轼
91+
> > - 电话:13333333333
92+
> > - 备注:眉州眉山人
93+
>
10794
10895
## 兼容性
10996

11097
### 应用兼容性
11198

112-
| 系统环境 | 特性 | 兼容性 |
113-
| --------------- | -------- | ----------------------------------------------- |
114-
| Windows 10+ | 深色模式 | 不支持深色模式 |
115-
| Windows 10+ | 显示缩放 | 切换 DPI 时无法自动缩放,缩放适配由操作系统完成 |
116-
| Windows 10+ | 字体缩放 | 不支持字体缩放 |
117-
| Windows 7+ | 显示缩放 | 仅支持 100%、125%、150% 级别图标缩放 |
118-
| Windows 7 - 8.1 | 应用启动 | 需要补丁 |
99+
| 系统环境 | 特性 | 兼容性 |
100+
| -------------- | -------- | ----------------------------------------------- |
101+
| Windows 10+ | 深色模式 | 不支持深色模式 |
102+
| Windows 10+ | 显示缩放 | 切换 DPI 时无法自动缩放,缩放适配由操作系统完成 |
103+
| Windows 10+ | 字体缩放 | 不支持字体缩放 |
104+
| Windows 7+ | 显示缩放 | 仅支持 100%、125%、150% 级别图标缩放 |
105+
| Windows 78.1 | 应用启动 | 需要补丁 |
119106

120107
#### 特别说明
121108

docs/CODE_OF_CONDUCT.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,23 @@ diverse, inclusive, and healthy community.
2121
Examples of behavior that contributes to a positive environment for our
2222
community include:
2323

24-
* Demonstrating empathy and kindness toward other people
25-
* Being respectful of differing opinions, viewpoints, and experiences
26-
* Giving and gracefully accepting constructive feedback
27-
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
- Demonstrating empathy and kindness toward other people
25+
- Being respectful of differing opinions, viewpoints, and experiences
26+
- Giving and gracefully accepting constructive feedback
27+
- Accepting responsibility and apologizing to those affected by our mistakes,
2828
and learning from the experience
29-
* Focusing on what is best not just for us as individuals, but for the overall
29+
- Focusing on what is best not just for us as individuals, but for the overall
3030
community
3131

3232
Examples of unacceptable behavior include:
3333

34-
* The use of sexualized language or imagery, and sexual attention or advances of
34+
- The use of sexualized language or imagery, and sexual attention or advances of
3535
any kind
36-
* Trolling, insulting or derogatory comments, and personal or political attacks
37-
* Public or private harassment
38-
* Publishing others' private information, such as a physical or email address,
36+
- Trolling, insulting or derogatory comments, and personal or political attacks
37+
- Public or private harassment
38+
- Publishing others' private information, such as a physical or email address,
3939
without their explicit permission
40-
* Other conduct which could reasonably be considered inappropriate in a
40+
- Other conduct which could reasonably be considered inappropriate in a
4141
professional setting
4242

4343
## Enforcement Responsibilities

docs/CODE_OF_CONDUCT.zh.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,19 @@
1414

1515
有助于为我们的社区创造积极环境的行为例子包括但不限于:
1616

17-
* 表现出对他人的同情和善意
18-
* 尊重不同的主张、观点和感受
19-
* 提出和大方接受建设性意见
20-
* 承担责任并向受我们错误影响的人道歉
21-
* 注重社区共同诉求,而非个人得失
17+
- 表现出对他人的同情和善意
18+
- 尊重不同的主张、观点和感受
19+
- 提出和大方接受建设性意见
20+
- 承担责任并向受我们错误影响的人道歉
21+
- 注重社区共同诉求,而非个人得失
2222

2323
不当行为例子包括:
2424

25-
* 使用情色化的语言或图像,及性引诱或挑逗
26-
* 嘲弄、侮辱或诋毁性评论,以及人身或政治攻击
27-
* 公开或私下的骚扰行为
28-
* 未经他人明确许可,公布他人的私人信息,如物理或电子邮件地址
29-
* 其他有理由认定为违反职业操守的不当行为
25+
- 使用情色化的语言或图像,及性引诱或挑逗
26+
- 嘲弄、侮辱或诋毁性评论,以及人身或政治攻击
27+
- 公开或私下的骚扰行为
28+
- 未经他人明确许可,公布他人的私人信息,如物理或电子邮件地址
29+
- 其他有理由认定为违反职业操守的不当行为
3030

3131
## 责任和权力
3232

docs/CONTRIBUTING.md

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,45 +4,49 @@
44

55
为了更好地理解开源贡献的流程,您可以参考《如何开源软件指南》中的“[为开源做贡献](https://opensource.guide/zh-hans/how-to-contribute/)”章节。此外,《开源指北》中的“[尝试参与开源](https://gitee.com/opensource-guide/guide/participating/roles.html)”章节也提供了详细的入门指导。
66

7-
在提交贡献时,您需要遵守[贡献者公约](./CODE_OF_CONDUCT.zh.md)各平台的规则以及当地法律法规
7+
在提交贡献时,您需要遵守[贡献者公约](./CODE_OF_CONDUCT.zh.md)当前平台的规则以及当地法律法规
88

99
## 翻译应用
1010

11-
敬请期待
11+
敬请期待
1212

1313
## 提交反馈
1414

1515
您可以在 [Gitee Issues][IssuesOnGitee][GitHub Issues][IssuesOnGithub] 平台中提交反馈。
1616

1717
## 参与开发
1818

19-
1. 确保 [Gitee][RepositoryOnGitee][GitHub][RepositoryOnGithub] 中没有相关的 PR;
20-
2. Fork 本仓库
21-
3. 使用 [Git](https://git-scm.com/) 克隆仓库到本地
22-
4. 阅读[开发指南](./dev/README.md),熟悉项目开发方法
23-
5. 创建分支,如 `feature/xxx``bugfix/xxx`
24-
6. 编写并提交代码
25-
7. 向本仓库提交 Pull Request。
19+
1. 确保 [Gitee][RepositoryOnGitee][GitHub][RepositoryOnGithub] 中没有相关的拉取请求(PR)
20+
2. Fork 本仓库
21+
3. 使用 [Git](https://git-scm.com/) 克隆仓库到本地
22+
4. 阅读[开发指南](./dev/README.md),熟悉项目开发方法
23+
5. 创建分支,如 `feature/xxx``bugfix/xxx`
24+
6. 编写并提交代码
25+
7. 向本仓库提交 PR
2626

2727
此外,有一些规范规则,请遵守:
2828

2929
## 代码规范
3030

31-
**Python`.py`**
31+
**Python (`.py`)**
3232

33-
- 函数参数必须声明类型
34-
- 单行最大字符数:120
35-
- 其他情况以 [PEP8](https://peps.python.org/pep-0008/) 为准
33+
- 函数参数必须声明类型
34+
- 单行最大 120 字符
35+
- 其他情况以 [PEP8](https://peps.python.org/pep-0008/) 为准
3636

37-
**Markdown`.md`**
37+
**Markdown (`.md`)**
3838

39-
- 不限制最大行数;
40-
- 详情请参考 `.markdownlint.json`
41-
- 其他情况以 [Markdownlint](https://github.com/DavidAnson/markdownlint) 为准
39+
- 不限制单行最大字符数
40+
- 详情请参考 `.markdownlint.json`
41+
- 其他情况以 [Markdownlint](https://github.com/DavidAnson/markdownlint) 为准
4242

4343
详情请参考 `.editorconfig`
4444

45-
## GIT 提交规范
45+
## 文档规范
46+
47+
遵守[《中文技术文档写作风格指南》](https://zh-style-guide.readthedocs.io/zh-cn/latest/index.html)和以下规则:
48+
49+
## Git 提交规范
4650

4751
遵循 [约定式提交](https://www.conventionalcommits.org/zh-hans/v1.0.0/)
4852

src/vcf_generator_lite/window/main/constants.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"""
1010

1111
USAGE = """使用说明:
12-
1. 把名字和电话以每行“姓名 电话号码 备注”的格式复制到下面的编辑框内,其中备注可忽略
13-
2. 点击“生成”,选择一个路径保存文件
12+
1. 把名字和电话以每行“姓名 电话号码 备注”的格式复制到下面的编辑框内,其中备注可忽略
13+
2. 点击“生成”,选择一个路径保存文件
1414
3. 将生成后的 VCF 文件复制到手机内,打开文件时选择使用“通讯录”,然后根据提示操作。
15-
4. 等待导入完成"""
15+
4. 等待导入完成"""

0 commit comments

Comments
 (0)