Skip to content

Commit ed80df0

Browse files
committed
Update README with firewall and Windows exe info
Added instructions to allow UDP 45845 and TCP 45846 in firewall settings if discovery or transfer is blocked. Also added a link to the Windows executable in both English and Chinese README files.
1 parent df67864 commit ed80df0

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ Glitter provides a **simple, terminal-based** alternative to GUI tools and compl
3838

3939
On first run, Glitter asks for language and device name and saves them. Next runs go straight to the main menu.
4040

41+
- Firewall: Allow UDP 45845 and TCP 45846 (transfer port) for the app if discovery/transfer is blocked.
42+
4143
### PyPI
4244

4345
[Released](https://pypi.org/project/glitter-cli/), recommended to install and run via [pipx](https://pipx.pypa.io/stable/):
@@ -58,6 +60,8 @@ On first run, Glitter asks for language and device name and saves them. Next run
5860

5961
### GitHub
6062

63+
- For Windows: [exe](https://github.com/scarletkc/glitter/releases)
64+
6165
Requirements: [Python 3.9+](https://www.python.org/downloads/) and install [deps](./requirements.txt)
6266

6367
- Linux/macOS/WSL/Windows (PowerShell/CMD) Run:
@@ -75,8 +79,6 @@ Requirements: [Python 3.9+](https://www.python.org/downloads/) and install [deps
7579
- [6] Settings: Change language/device name/port/encryption, clear history
7680
- [7] Quit: Exit the program
7781

78-
- Firewall: Allow UDP 45845 and TCP 45846 (transfer port) for the app if discovery/transfer is blocked.
79-
8082
## Files & Persistence
8183

8284
- Config: `~/.glitter/config.json` (language, device name, transfer port, encryption)

docs/README.zh-CN.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ Glitter 提供了一个**简洁、基于终端**的替代方案,相比 GUI 工
3838

3939
首次启动会提示选择语言与设备名称并保存。之后启动将直接进入主菜单。
4040

41+
- 防火墙:若发现/传输异常,请放行 UDP 45845 以及 TCP 45846(传输端口)。
42+
4143
### PyPI
4244

4345
[发布](https://pypi.org/project/glitter-cli/),推荐使用 [pipx](https://pipx.pypa.io/stable/) 安装与运行:
@@ -58,6 +60,8 @@ Glitter 提供了一个**简洁、基于终端**的替代方案,相比 GUI 工
5860

5961
### GitHub
6062

63+
- Windows二进制文件: [exe](https://github.com/scarletkc/glitter/releases)
64+
6165
要求:[Python 3.9+](https://www.python.org/downloads/),并安装[依赖](../requirements.txt)
6266

6367
- Linux/macOS/WSL/Windows (PowerShell/CMD) 运行:
@@ -75,8 +79,6 @@ Glitter 提供了一个**简洁、基于终端**的替代方案,相比 GUI 工
7579
- [6] 设置:修改语言/设备名/端口/加密,清空历史
7680
- [7] 退出
7781

78-
- 防火墙:若发现/传输异常,请放行 UDP 45845 以及 TCP 45846(传输端口)。
79-
8082
## 文件与持久化
8183

8284
- 配置:`~/.glitter/config.json`(语言、设备名、传输端口、加密)

0 commit comments

Comments
 (0)