Skip to content

Commit

Permalink
README update & setting text update
Browse files Browse the repository at this point in the history
  • Loading branch information
BHznJNs committed Dec 6, 2024
1 parent 1fab464 commit fca3009
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 3 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,5 @@ For wireless connection:

- [Shortcuts](./docs/shortcuts_en.md)
- [FAQs](./docs/faqs_en.md)
- [Limitations](./docs/limitations_en.md)
- [Development](./docs/development_en.md)
3 changes: 2 additions & 1 deletion README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,5 @@ __对于无线连接:__

- [快捷键](./docs/shortcuts_zh.md)
- [常见问题](./docs/faqs_zh.md)
- [开发](./docs/development_zh.md)
- [已知缺陷](./docs/limitations_zh.md)
- [开发](./docs/development_zh.md)
13 changes: 13 additions & 0 deletions docs/limitations_en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Known Limitations

## Connection Disconnects After Device Screen Turns Off

After the program successfully connects, if either the computer or Android device turns off the screen, the connection will be lost. To continue using the program, it is necessary to restart it and reconnect.

**Solution**: The program currently offers a "Keep Screen On" setting, which can prevent the Android device from turning off the screen, thus mitigating this limitation.

## Conflict with Bonjour

Some similar software, such as [barrier](https://github.com/debauchee/barrier) and [deskflow](https://github.com/deskflow/deskflow), use [Bonjour](https://developer.apple.com/bonjour/) to simplify network connections. However, based on feedback from some users, when running barrier and starting Bonjour on the computer, and then using this software, the connection success rate of this software is significantly reduced.

**Solution**: The exact cause of the conflict between this software and Bonjour is still unknown. You can try connecting with this software first, and then start barrier to avoid this issue.
14 changes: 14 additions & 0 deletions docs/limitations_zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# 已知缺陷

## 设备熄屏后会自动断开连接

在程序成功连接后,无论是电脑端还是安卓端熄屏,都会导致连接断开。此时需要重新启动程序并重新连接才能继续使用。

**解决办法**:目前程序内提供了“保持设备屏幕常亮”设置,开启后可以防止安卓端设备熄屏,从而避免此问题。

## 与 Bonjour 冲突

一些同类软件,如 [barrier](https://github.com/debauchee/barrier)[deskflow](https://github.com/deskflow/deskflow),会使用 [Bonjour](https://developer.apple.com/bonjour/) 来简化网络连接。
但根据部分用户反馈,在电脑上运行 barrier 并启动 Bonjour 后,再使用本软件时,会导致本软件的连接成功率显著降低。

**解决办法**:目前本软件与 Bonjour 的冲突原因尚不清楚。你可以尝试先使用本软件连接,再启动 barrier 来规避此问题。
4 changes: 2 additions & 2 deletions ui/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -162,8 +162,8 @@ def keep_wakeup_section():
info_label = ctk.CTkLabel(
master=keep_wakeup_frame,
font=smaller_font,
text=i18n(["When enabled, the device screen will stay on and prevent auto-sleep.",
"启用后,设备屏幕将持续亮屏,防止自动休眠。"]))
text=i18n(["When enabled, the Android device screen will stay on and prevent auto-sleep.",
"启用后,安卓设备屏幕将持续亮屏,防止自动休眠。"]))
keep_wakeup_frame.pack(fill="x", pady=(20, 0))
keep_wakeup_label.grid(row=0, column=0, padx=(20, 0), sticky="w")
check_box.grid(row=0, column=1)
Expand Down

0 comments on commit fca3009

Please sign in to comment.