style: 格式化代码
This commit is contained in:
87
FAQ.md
87
FAQ.md
@@ -2,15 +2,15 @@
|
||||
|
||||
## 什么是终端模拟器?
|
||||
|
||||
终端模拟器是在图形桌面环境中模拟并使用终端的应用程序, 例如 KDE Konsole, GNOME Terminal, Windows Terminal, iTerm2 等.
|
||||
终端模拟器是在图形桌面环境中模拟并使用终端的应用程序, 例如 KDE Konsole, GNOME Terminal, Windows Terminal, iTerm2 等.
|
||||
|
||||
较旧 Windows 的那个很寒酸的小黑窗口也是终端模拟器(conhost.exe), 但它对此软件基本用户界面(以及一切现代终端应用)支持不佳, 建议在 Windows 平台使用 WezTerm (支持 sixel) 或 Windows Terminal (不支持 sixel).
|
||||
较旧 Windows 的那个很寒酸的小黑窗口也是终端模拟器(conhost.exe), 但它对此软件基本用户界面(以及一切现代终端应用)支持不佳, 建议在 Windows 平台使用 WezTerm (支持 sixel) 或 Windows Terminal (不支持 sixel).
|
||||
|
||||
## 软件支持移动设备吗?
|
||||
|
||||
基本用户界面 (Textual TUI) 可在 Android Termux 中良好运行.
|
||||
基本用户界面 (Textual TUI) 可在 Android Termux 中良好运行.
|
||||
|
||||
此外, 正在开发的 KiriMemo 前端基于 KDE Kirigami 框架, 将原生支持 Android 和 iOS.
|
||||
此外, 正在开发的 KiriMemo 前端基于 KDE Kirigami 框架, 将原生支持 Android 和 iOS.
|
||||
|
||||
## HeurAMS 和 Anki 有什么区别?
|
||||
|
||||
@@ -29,13 +29,13 @@
|
||||
|
||||
## 软件是免费的吗?
|
||||
|
||||
是的, 完全免费, 且开源. 您无需支付任何费用即可使用全部功能.
|
||||
是的, 完全免费, 且开源. 您无需支付任何费用即可使用全部功能.
|
||||
|
||||
## 黑乎乎的这个界面我怎么用?
|
||||
|
||||
得益于微软几十年对用户进行的"命令行即落后"教育, 以及 `conhost.exe` 和 `cmd.exe` 的糟糕体验, 您对终端用户界面感到不适应是完全正常的.
|
||||
得益于微软几十年对用户进行的"命令行即落后"教育, 以及 `conhost.exe` 和 `cmd.exe` 的糟糕体验, 您对终端用户界面感到不适应是完全正常的.
|
||||
|
||||
但实际上, 虽然看起来像老式电脑屏幕, Textual 和终端标准其实比您想象得要现代一些.
|
||||
但实际上, 虽然看起来像老式电脑屏幕, Textual 和终端标准其实比您想象得要现代一些.
|
||||
|
||||
### 可以用鼠标
|
||||
|
||||
@@ -44,6 +44,7 @@
|
||||
所以可能和您的想象不同, 您事实上可以直接用鼠标点击按钮, 就像使用普通软件一样.
|
||||
|
||||
### 也可以用键盘
|
||||
|
||||
- `Tab` 键在不同区域之间切换焦点
|
||||
- `方向键` 在列表中上下移动
|
||||
- `Enter` 确认选择
|
||||
@@ -51,6 +52,7 @@
|
||||
- 屏幕上会有按键提示, 例如 `[n] 导航器` 表示按 `n` 键打开导航器
|
||||
|
||||
### 触屏也可以
|
||||
|
||||
在平板或手机 Termux 中, 您可以触摸或者滑动屏幕操作.
|
||||
|
||||
## 我怎么启动这个软件?
|
||||
@@ -58,6 +60,7 @@
|
||||
首先需要确保系统中安装了 Python (推荐 3.12.13 版本) 并安装了 HeurAMS 的所需组件.
|
||||
|
||||
### Windows
|
||||
|
||||
打开"命令提示符"或"PowerShell", 输入以下命令后按回车, 或者把这玩意另存为快捷方式:
|
||||
|
||||
```
|
||||
@@ -65,22 +68,24 @@ python -m heurams.interface
|
||||
```
|
||||
|
||||
### macOS
|
||||
|
||||
打开"终端"应用程序, 输入以上命令.
|
||||
|
||||
### Linux
|
||||
|
||||
打开您的终端模拟器 (一般是按 Ctrl + Alt + T), 输入以上命令.
|
||||
|
||||
如果您觉得每次输入命令太麻烦, 可以创建一个桌面快捷方式或脚本文件, 详见网上的相关教程.
|
||||
|
||||
## 我怎么退出软件?
|
||||
|
||||
按键盘上的 `q` 键返回主界面后退出.
|
||||
按键盘上的 `q` 键返回主界面后退出.
|
||||
|
||||
您的学习进度会自动保存, 不会丢失.
|
||||
|
||||
## 我看不到图片怎么办?
|
||||
|
||||
终端模拟器需要支持 sixel 图像协议才能显示图片.
|
||||
终端模拟器需要支持 sixel 图像协议才能显示图片.
|
||||
|
||||
- WezTerm (适用于几乎所有操作系统): 支持
|
||||
- KDE Konsole: 支持
|
||||
@@ -124,15 +129,15 @@ python -m heurams.interface
|
||||
|
||||
## 字体太小/太大怎么办?
|
||||
|
||||
在您的终端模拟器设置中找到"字体大小"选项进行调整.
|
||||
在您的终端模拟器设置中找到"字体大小"选项进行调整.
|
||||
|
||||
软件会跟随终端的字体设置.
|
||||
|
||||
## 为什么我的界面和截图不一样?
|
||||
|
||||
截图使用的是 KDE Plasma 桌面上的 Konsole, 80x25 字符尺寸, Cascadia Code 和 Noto Sans SC 字体.
|
||||
截图使用的是 KDE Plasma 桌面上的 Konsole, 80x25 字符尺寸, Cascadia Code 和 Noto Sans SC 字体.
|
||||
|
||||
如果您的终端尺寸更大, 界面会更宽裕; 如果使用不同字体或者不同操作系统, 视觉效果会略有差异.
|
||||
如果您的终端尺寸更大, 界面会更宽裕; 如果使用不同字体或者不同操作系统, 视觉效果会略有差异.
|
||||
|
||||
功能上完全一致.
|
||||
|
||||
@@ -144,9 +149,9 @@ python -m heurams.interface
|
||||
|
||||
并且这种方式于学术研究与实验不利, 用户自评分产生的数据是不可靠的.
|
||||
|
||||
因此 HeurAMS 的前端内建了基于用户行为分析的自动评分系统, 也就是"谜题".
|
||||
因此 HeurAMS 的前端内建了基于用户行为分析的自动评分系统, 也就是"谜题".
|
||||
|
||||
它会根据题目本身难度和您的答题行为(包括但不限于正确性, 操作回退次数, 有效答题时间)并自动为您评分.
|
||||
它会根据题目本身难度和您的答题行为(包括但不限于正确性, 操作回退次数, 有效答题时间)并自动为您评分.
|
||||
|
||||
但如果您或者某个单元集选择使用 `basic_puzzle`, 或者打算自己实现自动评分系统, 分数含义如下:
|
||||
|
||||
@@ -170,7 +175,7 @@ python -m heurams.interface
|
||||
|
||||
## 我每天都要打开软件吗? 不学会怎样?
|
||||
|
||||
理论上不需要每天打开. 软件会自动记录每个知识点下次该复习的时间.
|
||||
理论上不需要每天打开. 软件会自动记录每个知识点下次该复习的时间.
|
||||
|
||||
但建议您每天打开软件看下状态.
|
||||
|
||||
@@ -183,9 +188,9 @@ python -m heurams.interface
|
||||
|
||||
## 能同时学多个科目吗?
|
||||
|
||||
可以.
|
||||
可以.
|
||||
|
||||
每个科目或课程可以做成独立的"单元集".
|
||||
每个科目或课程可以做成独立的"单元集".
|
||||
|
||||
## 我换电脑了, 怎么迁移数据?
|
||||
|
||||
@@ -215,13 +220,13 @@ python -m heurams.interface
|
||||
|
||||
## 同时用 Anki 和 HeurAMS 会冲突吗?
|
||||
|
||||
不会.
|
||||
不会.
|
||||
|
||||
两者是独立的软件, 数据互不影响. 您可以逐步将内容迁移到 HeurAMS, 也可以两个一起用.
|
||||
|
||||
## 我需要安装 Python 吗?
|
||||
|
||||
需要的, HeurAMS 是基于 Python 的软件.
|
||||
需要的, HeurAMS 是基于 Python 的软件.
|
||||
|
||||
- Windows/macOS: 从 python.org 下载安装即可
|
||||
- Linux: 系统通常已自带 Python
|
||||
@@ -233,9 +238,9 @@ HeurAMS 建议的 Python 版本是 3.12.13.
|
||||
|
||||
## 软件安全吗? 会不会有病毒?
|
||||
|
||||
HeurAMS 是开源软件, 所有代码公开可查阅, 不会有病毒或后门.
|
||||
HeurAMS 是开源软件, 所有代码公开可查阅, 不会有病毒或后门.
|
||||
|
||||
它只读写自己的 `data/` 文件夹, 不会动您电脑上的其他文件.
|
||||
它只读写自己的 `data/` 文件夹, 不会动您电脑上的其他文件.
|
||||
|
||||
## 软件报错, 出现一堆我看不懂的英文怎么办?
|
||||
|
||||
@@ -249,13 +254,13 @@ HeurAMS 是开源软件, 所有代码公开可查阅, 不会有病毒或后门.
|
||||
|
||||
## 怎么看我学了多少? 有统计吗?
|
||||
|
||||
仪表盘界面会显示统计信息.
|
||||
仪表盘界面会显示统计信息.
|
||||
|
||||
您可以通过导航器随时回到仪表盘查看.
|
||||
|
||||
## 我觉得复习太快/太慢了, 能调吗?
|
||||
|
||||
可以. 您可以通过切换算法或调整算法参数或改变记忆单元数来改变复习节奏.
|
||||
可以. 您可以通过切换算法或调整算法参数或改变记忆单元数来改变复习节奏.
|
||||
|
||||
在设置界面可以找到相关设置.
|
||||
|
||||
@@ -277,13 +282,13 @@ HeurAMS 是开源软件, 所有代码公开可查阅, 不会有病毒或后门.
|
||||
|
||||
## 哪里可以下载别人做好的单元集?
|
||||
|
||||
目前项目还没有官方的单元集市场.
|
||||
目前项目还没有官方的单元集市场.
|
||||
|
||||
但随着社区发展, 未来可能会有用户分享的单元集, 您也可以和朋友互相分享.
|
||||
|
||||
## 我能把学习内容导出打印吗?
|
||||
|
||||
可以.
|
||||
可以.
|
||||
|
||||
软件本身支持将单元集导出为单一文本文件, 您可以用任何文本编辑器打开并打印. 也可以直接复制内容到 Word 等软件.
|
||||
|
||||
@@ -318,13 +323,13 @@ data/repo/my_pack/
|
||||
|
||||
## 为什么不用 Flutter?
|
||||
|
||||
Flutter 是构建跨平台图形界面的优秀框架, HeurAMS 的设计目标之一是保持核心程序库独立于特定前端.
|
||||
Flutter 是构建跨平台图形界面的优秀框架, HeurAMS 的设计目标之一是保持核心程序库独立于特定前端.
|
||||
|
||||
但 Flutter 在 "集成 python" 方面不如 PyOtherSide, 只能通过 RPC 标准件和程序库通讯, 并且 Flutter 的桌面多窗口一直以来没有被官方稳定支持, 所以我们暂时放弃了 Flutter 而选择了 Kirigami.
|
||||
|
||||
当前我们优先开发了基于 Textual 的 TUI 前端和基于 Kirigami 的原生前端, 但这不排除未来出现 Flutter 或其他框架前端的可能性.
|
||||
|
||||
如果您有兴趣开发 Flutter 前端, 欢迎参考[贡献指南](CONTRIBUTING.md#新的用户界面前端).
|
||||
如果您有兴趣开发 Flutter 前端, 欢迎参考[贡献指南](CONTRIBUTING.md#%E6%96%B0%E7%9A%84%E7%94%A8%E6%88%B7%E7%95%8C%E9%9D%A2%E5%89%8D%E7%AB%AF).
|
||||
|
||||
## 软件需要联网吗?
|
||||
|
||||
@@ -336,11 +341,11 @@ Flutter 是构建跨平台图形界面的优秀框架, HeurAMS 的设计目标
|
||||
|
||||
## 许可证中的"本机 API 调用豁免"是什么?
|
||||
|
||||
简言之, 如果您在自己的程序中通过本地进程间 API 方式的通信 (如同一主机上的 RPC 调用) 使用 HeurAMS, 而无需通过网络转发, 则您的程序不受 AGPL-3.0 许可证的约束.
|
||||
简言之, 如果您在自己的程序中通过本地进程间 API 方式的通信 (如同一主机上的 RPC 调用) 使用 HeurAMS, 而无需通过网络转发, 则您的程序不受 AGPL-3.0 许可证的约束.
|
||||
|
||||
这项附加条款旨在鼓励第三方前端和工具的开发.
|
||||
这项附加条款旨在鼓励第三方前端和工具的开发.
|
||||
|
||||
所以 HeurAMS 的许可证实质上是比原始的 AGPL-3.0 松一点的.
|
||||
所以 HeurAMS 的许可证实质上是比原始的 AGPL-3.0 松一点的.
|
||||
|
||||
## HeurAMS 和百词斩有什么区别?
|
||||
|
||||
@@ -360,29 +365,29 @@ Flutter 是构建跨平台图形界面的优秀框架, HeurAMS 的设计目标
|
||||
|
||||
## 百词斩有图片联想记忆, HeurAMS 也有吗?
|
||||
|
||||
支持.
|
||||
支持.
|
||||
|
||||
如果您的终端支持图片显示 (如 Konsole 或者 WezTerm), 单元集中可以包含图片, 复习时会直接展示.
|
||||
如果您的终端支持图片显示 (如 Konsole 或者 WezTerm), 单元集中可以包含图片, 复习时会直接展示.
|
||||
|
||||
但图片需要您自己放入单元集.
|
||||
但图片需要您自己放入单元集.
|
||||
|
||||
## 百词斩有打卡和排行榜, HeurAMS 有吗?
|
||||
|
||||
目前没有.
|
||||
目前没有.
|
||||
|
||||
HeurAMS 不设打卡、排行榜或社交功能, 也不向任何人收集您的学习数据.
|
||||
HeurAMS 不设打卡、排行榜或社交功能, 也不向任何人收集您的学习数据.
|
||||
|
||||
## 百词斩有现成的词书, HeurAMS 去哪找内容?
|
||||
|
||||
百词斩的课程是官方制作好的, HeurAMS 的内容需要您自己创建或从社区获取.
|
||||
百词斩的课程是官方制作好的, HeurAMS 的内容需要您自己创建或从社区获取.
|
||||
|
||||
详见"如何创建自己的单元集?".
|
||||
|
||||
## 百词斩在手机上用很方便, HeurAMS 能在手机用吗?
|
||||
|
||||
可以, 但现阶段需要您"折腾"一下.
|
||||
可以, 但现阶段需要您"折腾"一下.
|
||||
|
||||
Android 手机安装 Termux 后可运行 HeurAMS 的基本用户界面.
|
||||
Android 手机安装 Termux 后可运行 HeurAMS 的基本用户界面.
|
||||
|
||||
此外, 正在开发的 KiriMemo 前端将原生支持 Android 和 iOS, 这就不需要用户去折腾了.
|
||||
|
||||
@@ -396,12 +401,12 @@ Android 手机安装 Termux 后可运行 HeurAMS 的基本用户界面.
|
||||
|
||||
考虑到百词斩的算法和词库是事实上闭源的, 我们无从得知算法来源.
|
||||
|
||||
但 HeurAMS 的架构设计可保证单元集制成后效果不比百词斩差, 甚至优于百词斩.
|
||||
但 HeurAMS 的架构设计可保证单元集制成后效果不比百词斩差, 甚至优于百词斩.
|
||||
|
||||
HeurAMS 的间隔重复算法基于相同的认知科学原理, 且算法透明可调, 您可以自由选择最适合自己的调度策略.
|
||||
HeurAMS 的间隔重复算法基于相同的认知科学原理, 且算法透明可调, 您可以自由选择最适合自己的调度策略.
|
||||
|
||||
## 如何参与项目?
|
||||
|
||||
详见[贡献指南](CONTRIBUTING.md).
|
||||
详见[贡献指南](CONTRIBUTING.md).
|
||||
|
||||
即使不是开发者, 您也可以通过编写文档、制作记忆单元集、翻译界面、答疑等方式参与.
|
||||
|
||||
Reference in New Issue
Block a user