From 9bc1efd4dfaaff1137eda455aedcdd92428cdddb Mon Sep 17 00:00:00 2001
From: Nemo Xiong
Date: Mon, 8 Apr 2024 00:05:40 +1000
Subject: [PATCH] readme: see desc
add crucial information necessary for best visual effect
---
README.md | 9 +++++++++
README.zh-CN.md | 9 +++++++++
2 files changed, 18 insertions(+)
diff --git a/README.md b/README.md
index b098e9f..4d66923 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,15 @@
+> [!IMPORTANT]
+> For best visual quality, you need a terminal which don't print control characters. On Windows, conhost.exe is not supported, while newest Windows Terminal has the issue. It works quite well with the default terminal on macOS.
+>
+> For more information, see [microsoft/terminal/issues/17016](https://github.com/microsoft/terminal/issues/17016), [gui-cs/Terminal.Gui/issues/2928](https://github.com/gui-cs/Terminal.Gui/issues/2928)
+>
+> Kindly install `windows-terminal@1.19.10302.0` if you are on Windows (which I tested)
+>
+> This is NOT a Soniclair.Cli issue.
+
## An album-centered subsonic client for the Terminal
SonicLair.Cli is a terminal music client for subsonic compatible music servers built using .NET Core 6, designed to be cross-platform (Windows, Linux and macOS). It's derived from [SonicLair.Net](https://github.com/thelinkin3000/SonicLair.NET).
diff --git a/README.zh-CN.md b/README.zh-CN.md
index 29102db..cbbfe97 100644
--- a/README.zh-CN.md
+++ b/README.zh-CN.md
@@ -11,6 +11,15 @@
+> [!IMPORTANT]
+> 为了展现最佳视觉效果,你需要一个不打印控制字符的终端。在 Windows 上, conhost.exe 不受支持。最新版的 Windows Terminal 同样也有不兼容问题。在 macOS 上使用默认终端似乎没问题。
+>
+> 如欲了解更多信息,请参照:[microsoft/terminal/issues/17016](https://github.com/microsoft/terminal/issues/17016) 和 [gui-cs/Terminal.Gui/issues/2928](https://github.com/gui-cs/Terminal.Gui/issues/2928)
+>
+> 如果你使用 Windows,请安装 `windows-terminal@1.19.10302.0` (我的版本)
+>
+> 该问题不是 Soniclair.Cli 导致的.
+
## 一个以专辑为中心,运行在终端里的 Subsonic 客户端
SonicLair.Cli 是一个使用 .NET Core 6 构建的运行在终端里的 Subsonic 客户端,跨平台 (Windows, Linux 和 macOS)。 它从 [SonicLair.Net](https://github.com/thelinkin3000/SonicLair.NET) 分叉。