Skip to content

Commit 5dc0d70

Browse files
Jesse205Jesse205
committed
docs: 更新文档中的下载包表格格式与内容结构
统一修复了文档里下载包表格的格式问题，重构了README.md的文档结构，将Python Wheel使用说明、vCard导入指南等内容迁移至对应文档页面，精简冗余内容
1 parent 7811ada commit 5dc0d70

3 files changed

Lines changed: 17 additions & 133 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 121 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,7 @@ VCF Generator Lite is a simple and efficient tool that converts contact lists in
3636
- **Editing Assistance**: Displays line numbers in the text area, supports one-click quote removal.
3737
- **Localization**: Supports Simplified Chinese and English, with phone number recognition for China (including Hong Kong, Macau, and Taiwan regions).
3838
- **Lightweight**: Provided as a Python ZIP application package.
39-
- **Ad-Free**: No advertisements; just download and use.
40-
- **Open Source**: Open-sourced under the Apache License 2.0.
41-
- **Free**: No payment required to use.
39+
- **Free and Open Source**: Licensed under Apache License 2.0, ad-free, no payment required.
4240

4341
## Screenshots
4442

@@ -47,9 +45,7 @@ VCF Generator Lite is a simple and efficient tool that converts contact lists in
4745

4846
## Getting the App
4947

50-
### Downloading the Packages
51-
52-
You can download the package through the following channels:
48+
Download packages from the following channels:
5349

5450
- [Gitee Releases][release-gitee]
5551
- [GitHub Releases][release-github]
@@ -63,44 +59,6 @@ Please select the appropriate software package for your platform:
6359
| Cross-platform | Python Wheel | Optional | vcf_generator_lite-\<version\>-**py3-none-any**.*whl* |
6460
| Cross-platform | Python ZIP Application | No | VCFGeneratorLite-\<version\>-**py3**.*pyzw* |
6561

66-
### Using Python Wheel
67-
68-
Python Wheel (`.whl`) files are suitable for users familiar with the command line. It is recommended to run them in an isolated environment to avoid dependency conflicts.
69-
70-
#### Method 1: Temporary Execution (Simplest, No Installation Required)
71-
72-
Use `uvx`, which automatically creates a temporary environment and runs the program.
73-
74-
```bash
75-
uvx <path-to-whl-file>
76-
```
77-
78-
> [!NOTE]
79-
>
80-
> `uvx` is the shorthand for `uv tool run`, provided by the [uv][uv-homepage] tool.
81-
82-
#### Method 2: Install for Long-Term Use
83-
84-
Install using one of the tools below, which automatically create an isolated virtual environment without affecting your system Python.
85-
86-
```bash
87-
# Using pipx
88-
pipx install <path-to-whl-file>
89-
90-
# Or using uv
91-
uv tool install <path-to-whl-file>
92-
```
93-
94-
After installation, simply run the following command in your terminal:
95-
96-
```bash
97-
vcf-generator-lite
98-
```
99-
100-
> [!TIP]
101-
>
102-
> If you haven't installed `uv` or `pipx` yet, please run `pip install uv` or `pip install pipx` first.
103-
10462
## Usage
10563

10664
1. Paste your contacts in the format `Name Phone Note` into the text field. The note is optional.
@@ -111,77 +69,11 @@ vcf-generator-lite
11169
Xie Lingyun 13666666666
11270
```
11371
2. Click **Generate**, select a path to save the file.
114-
3. You can use the generated vCard file wherever you need it.
115-
116-
> [!NOTE]
117-
>
118-
> - You can use both tabs and spaces to separate fields.
119-
> - Multiple spaces and tabs between fields will be automatically merged into one.
120-
>
121-
> Example: `Han Meimei 13333333333 A well-known girl` will be recognized as
122-
>
123-
> | Name | Phone | Note |
124-
> | ---------- | ----------- | ----------------- |
125-
> | Han Meimei | 13333333333 | A well-known girl |
126-
127-
### Using vCard Files
128-
129-
<details>
130-
<summary>Import to Mobile Contacts</summary>
72+
3. You can use the generated vCard file wherever you need it. See [Using vCard Files](./docs/guides/vcard-usage.md) for details.
13173

132-
1. Transfer the vCard file to your phone.
133-
2. Open the vCard file and select **Contacts**, then follow the prompts.
134-
3. Wait for the import to complete.
74+
For more information, see [Quick Start](./docs/getting-started.md).
13575

136-
</details>
137-
138-
<details>
139-
<summary>Import to QQ Mail</summary>
140-
141-
1. Open the new version of the QQ Mail website.
142-
2. In the sidebar, select **Apps > Contacts**, then choose **Manage > Import contacts**.
143-
3. In the dialog box that appears, click the **Select File** button and select your vCard file.
144-
4. Click **Start to import**.
145-
146-
</details>
147-
148-
<details>
149-
<summary>Import to Lark</summary>
150-
151-
1. Open the Lark client.
152-
2. In the sidebar, select **Contacts > Email Contacts**, then choose the **Add > Import contacts** button.
153-
3. In the dialog box that appears, select or drag your vCard file.
154-
4. Click **Import**.
155-
156-
</details>
157-
158-
## Compatibility
159-
160-
### System Requirements
161-
162-
| Software Package Type | System Requirements |
163-
| ------------------------------------ | ----------------------------- |
164-
| Windows Installer & Portable Package | Windows 8.1 or later |
165-
| Python ZIP Application | Python 3.12 or later, Tkinter |
166-
167-
If you need to use this application on Windows 8 or earlier versions, please see [Running on older versions of Windows](./docs/troubleshooting/runs-on-older-windows.md).
168-
169-
If you need to double-click to launch a Python ZIP application directly on Windows, please install [Python Install Manager][pymanager] (recommended) or [Python Launcher][pylauncher].
170-
171-
### vCard Compatibility
172-
173-
- **vCard Version**: 2.1
174-
- **Supported Fields**: Name, Phone Number, Note
175-
- **Known Issues**:
176-
- **Windows Contacts**: May display garbled characters in non-UTF-8 environments.
177-
178-
### Other Compatibility
179-
180-
| System Environment | Issue | Description | Workaround |
181-
| -------------------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
182-
| Windows 10 or later | Dark mode not supported | Tkinter has no built-in dark theme. | Use [high contrast themes][windows-high-contrast-support] or modify the system theme with third-party tools (e.g., [Rectify11][rectify11]). |
183-
| Windows 10 or later | UI becomes blurry when DPI changes | App doesn't support DPI adjustment after startup | Avoid changing DPI while the application is running. |
184-
| Python Install Manager 26.0 or earlier | Command line window appears | Doesn't support automatic upgrade to windowed Python interpreter. ([python/pymanager#216]) | Upgrade the Python Install Manager to version 26.1 or later, or use the [Python launcher][pylauncher]. |
76+
For system requirements, vCard compatibility, and known issues, see [Compatibility](./docs/reference/compatibility.md).
18577

18678
## Credits
18779

@@ -223,11 +115,3 @@ Copyright © 2023-2026 Jesse205
223115
[stargazers-gitee]: https://gitee.com/hellotool/VCFGeneratorLiteWithTkinter/stargazers
224116

225117
[workflow-test]: https://github.com/hellotool/VCFGeneratorLiteWithTkinter/actions/workflows/test.yml
226-
227-
[pylauncher]: https://docs.python.org/zh-cn/3.15/using/windows.html#python-launcher-for-windows-deprecated
228-
[pymanager]: https://docs.python.org/zh-cn/3.15/using/windows.html#python-install-manager
229-
[windows-high-contrast-support]: https://support.microsoft.com/en-us/windows/turn-high-contrast-mode-on-or-off-in-windows-909e9d89-a0f9-a3a9-b993-7a6dcee85025
230-
[rectify11]: https://www.rectify11.com/
231-
[uv-homepage]: https://docs.astral.sh/uv/
232-
233-
[python/pymanager#216]: https://github.com/python/pymanager/issues/216

‎README.zh-CN.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,12 @@ VCF 生成器 Lite 是一个简单高效的工具，可以将联系人列表转
5454

5555
根据您的使用平台选择相应的软件包：
5656

57-
| 平台 | 软件包类型 | 需要安装 | 文件 |
58-
| ------- | --------------- | -------- | --------------------------------------------------------- |
59-
| Windows | 安装程序 | 是 | VCFGeneratorLite-v\<应用版本\>-**win-amd64**-setup.exe |
60-
| Windows | 便携包 | 否 | VCFGeneratorLite-v\<应用版本\>-**win-amd64**-portable.zip |
61-
| 跨平台 | Python Wheel | 可选 | vcf_generator_lite-\<应用版本\>-**py3-none-any**.whl |
62-
| 跨平台 | Python ZIP 应用 | 否 | VCFGeneratorLite-v\<应用版本\>-**py3**.pyzw |
57+
| 平台 | 软件包类型 | 需要安装 | 文件 |
58+
| ------- | --------------- | -------- | ----------------------------------------------------------- |
59+
| Windows | 安装程序 | 是 | VCFGeneratorLite-v\<应用版本\>-**win-amd64**--*setup.exe* |
60+
| Windows | 便携包 | 否 | VCFGeneratorLite-v\<应用版本\>-**win-amd64**-*portable.zip* |
61+
| 跨平台 | Python Wheel | 可选 | vcf_generator_lite-\<应用版本\>-**py3-none-any**.*whl* |
62+
| 跨平台 | Python ZIP 应用 | 否 | VCFGeneratorLite-v\<应用版本\>-**py3**.*pyzw* |
6363

6464
## 使用方法
6565

‎docs/getting-started.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@
1313

1414
根据您的系统环境选择合适的软件包：
1515

16-
| 平台 | 软件包类型 | 需要安装 | 文件 |
17-
| ------- | --------------- | -------- | --------------------------------------------------------- |
18-
| Windows | 安装程序 | 是 | VCFGeneratorLite-v\<应用版本\>-**win-amd64**-setup.exe |
19-
| Windows | 便携包 | 否 | VCFGeneratorLite-v\<应用版本\>-**win-amd64**-portable.zip |
20-
| 跨平台 | Python Wheel | 可选 | vcf_generator_lite-\<应用版本\>-**py3-none-any**.whl |
21-
| 跨平台 | Python ZIP 应用 | 否 | VCFGeneratorLite-v\<应用版本\>-**py3**.pyzw |
16+
| 平台 | 软件包类型 | 需要安装 | 文件 |
17+
| ------- | --------------- | -------- | ----------------------------------------------------------- |
18+
| Windows | 安装程序 | 是 | VCFGeneratorLite-v\<应用版本\>-**win-amd64**--*setup.exe* |
19+
| Windows | 便携包 | 否 | VCFGeneratorLite-v\<应用版本\>-**win-amd64**-*portable.zip* |
20+
| 跨平台 | Python Wheel | 可选 | vcf_generator_lite-\<应用版本\>-**py3-none-any**.*whl* |
21+
| 跨平台 | Python ZIP 应用 | 否 | VCFGeneratorLite-v\<应用版本\>-**py3**.*pyzw* |
2222

2323
> [!TIP]
2424
>

0 commit comments

Comments
 (0)